Package com._1c.g5.v8.dt.core.library.repository

Interface ILibraryRepository

All Superinterfaces:

IManagedService

public interface ILibraryRepository
extends IManagedService

A library repository handling registration, deleting libraries. Also allows to check whether the library is registered in the repository and get a list of all registered libraries.

Method Summary

Modifier and Type	Method	Description
void	deleteLibrary(LibraryDescriptor libraryDescriptor)	Deletes the library from the repository.
Collection<LibraryDescriptor>	getAllRegisteredLibraries()	Returns the collection of all registered libraries.
Collection<LibraryDescriptor>	getAllRegisteredLibraries(LibraryDependency libraryDependency)	Returns the collection of all registered libraries according to the specified dependency on the library.
boolean	isLibraryRegistered(LibraryDescriptor libraryDescriptor)	Checks whether the given library is registered in the repository.
void	refresh(org.eclipse.core.runtime.IProgressMonitor monitor)	Refreshes the current collection of registered libraries.
LibraryDescriptor	registerLibrary(Path libraryPath, org.eclipse.core.runtime.IProgressMonitor monitor)	Registers the library in the repository if such a library has not been registered before.

Methods inherited from interface com._1c.g5.wiring.IManagedService

activate, deactivate

Method Detail

registerLibrary

LibraryDescriptor registerLibrary(Path libraryPath,
                                  org.eclipse.core.runtime.IProgressMonitor monitor)
                           throws IOException,
                                  InvalidLibraryDescriptorException,
                                  LibraryLockFailedException

Registers the library in the repository if such a library has not been registered before. If such a library is already registered, then this library descriptor is returned.

Parameters:

libraryPath - the library file path, cannot be null

monitor - the monitor to indicate the progress, may be null

Returns:

the registered library descriptor, never null

Throws:

IOException - if an I/O error has occurred

InvalidLibraryDescriptorException - if failed to found library description attributes

LibraryLockFailedException - if failed to lock to handle the library

deleteLibrary

void deleteLibrary(LibraryDescriptor libraryDescriptor)
            throws IOException,
                   LibraryLockFailedException

Deletes the library from the repository.

Parameters:

libraryDescriptor - the library descriptor to delete, cannot be null

Throws:

IOException - if an I/O error has occurred

LibraryLockFailedException - if failed to lock to handle the library

isLibraryRegistered

boolean isLibraryRegistered(LibraryDescriptor libraryDescriptor)

Checks whether the given library is registered in the repository.

Parameters:

libraryDescriptor - the library descriptor to check, cannot be null

Returns:

true if the library is registered in the repository, false otherwise

getAllRegisteredLibraries

Collection<LibraryDescriptor> getAllRegisteredLibraries()

Returns the collection of all registered libraries.

Returns:

the unmodifiable collection of all registered libraries, never null

getAllRegisteredLibraries

Collection<LibraryDescriptor> getAllRegisteredLibraries(LibraryDependency libraryDependency)

Returns the collection of all registered libraries according to the specified dependency on the library.

Parameters:

libraryDependency - the dependency on the library, cannot be null

Returns:

the unmodifiable collection of all registered libraries, never null

refresh

void refresh(org.eclipse.core.runtime.IProgressMonitor monitor)

Refreshes the current collection of registered libraries.

Parameters:

monitor - the monitor to indicate the progress, may be null