org.eclipse.core.runtime
Interface ILibrary

public interface ILibrary

A runtime library declared in a plug-in. Libraries contribute elements to the search path. These contributions are specified as a path to a directory or Jar file. This path is always considered to be relative to the containing plug-in.

Libraries are typed. The type is used to determine to which search path the library's contribution should be added. The valid types are: CODE and RESOURCE.

This interface is not intended to be implemented by clients.

See Also:

IPluginDescriptor.getRuntimeLibraries()

Field Summary

static String	CODE Constant string (value "code") indicating the code library type.
static String	RESOURCE Constant string (value "resource") indicating the resource library type.

Method Summary

String[]	getContentFilters() Returns the content filters, or null.
IPath	getPath() Returns the path of this runtime library, relative to the installation location.
String	getType() Returns this library's type.
boolean	isExported() Returns whether the library is exported.
boolean	isFullyExported() Returns whether this library is fully exported.

Field Detail

CODE

public static final String CODE

Constant string (value "code") indicating the code library type.

See Also:

LibraryModel.CODE, Constant Field Values

RESOURCE

public static final String RESOURCE

Constant string (value "resource") indicating the resource library type.

See Also:

LibraryModel.RESOURCE, Constant Field Values

Method Detail

getContentFilters

public String[] getContentFilters()

Returns the content filters, or null. Each content filter identifies a specific class, or a group of classes, using a notation and matching rules equivalent to Java import declarations (e.g., "java.io.File", or "java.io.*"). Returns null if the library is not exported, or it is fully exported (no filtering).

Returns:

the content filters, or null if none

getPath

public IPath getPath()

Returns the path of this runtime library, relative to the installation location.

Returns:

the path of the library

See Also:

IPluginDescriptor.getInstallURL()

getType

public String getType()

Returns this library's type.

Returns:

the type of this library. The valid types are: CODE and RESOURCE.

See Also:

CODE, RESOURCE

isExported

public boolean isExported()

Returns whether the library is exported. The contents of an exported library may be visible to other plug-ins that declare a dependency on the plug-in containing this library, subject to content filtering. Libraries that are not exported are entirely private to the declaring plug-in.

Returns:

true if the library is exported, false if it is private

isFullyExported

public boolean isFullyExported()

Returns whether this library is fully exported. A library is considered fully exported iff it is exported and has no content filters.

Returns:

true if the library is fully exported, and false if it is private or has filtered content