Package org.eclipse.pde.core.plugin
Interface IPluginLibrary
- All Superinterfaces:
IAdaptable,IPluginObject,IWritable
The class that implements this interface represents a
reference to the library that is defined in the plug-in
manifest.
- Restriction:
- This interface is not intended to be implemented by clients.
- Restriction:
- This interface is not intended to be extended by clients.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringA library type indicating the library contains code.static final StringA name of the property that will be used to notify about changes in the content filters.static final StringA name of the property that will be used to notify about changes of the "exported" field.static final StringA name of the property that will be used to notify about changes in the content filters.static final StringA name of the property that will be used to notify about of the 'type' field.static final StringA library type indicating the library contains resource files.Fields inherited from interface org.eclipse.pde.core.plugin.IPluginObject
P_NAME -
Method Summary
Modifier and TypeMethodDescriptionvoidaddContentFilter(String filter) Export a particular package in a library.String[]Returns optional context filters that should be applied to calculate what classes to export from this library.String[]Returns optional package prefixes that can be used to make library lookup faster..getType()Returns the type of this library.booleanReturns true if this library contains types that will be visible to other plug-ins.booleanReturns true if all the types in this library will be visible to other plug-ins.voidremoveContentFilter(String filter) Remove a package from the export list.voidsetContentFilters(String[] filters) Sets the optional content filters for this library.voidsetExported(boolean value) Sets whether types in this library will be visible to other plug-ins.voidsetPackages(String[] packages) Sets the optional package prefixes for this library.voidSets the library type.Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapterMethods inherited from interface org.eclipse.pde.core.plugin.IPluginObject
getModel, getName, getParent, getPluginBase, getPluginModel, getResourceString, getTranslatedName, isInTheModel, isValid, setInTheModel, setName
-
Field Details
-
P_EXPORTED
A name of the property that will be used to notify about changes of the "exported" field.- See Also:
-
P_PACKAGES
A name of the property that will be used to notify about changes in the content filters.- See Also:
-
P_CONTENT_FILTERS
A name of the property that will be used to notify about changes in the content filters.- See Also:
-
P_TYPE
A name of the property that will be used to notify about of the 'type' field.- See Also:
-
CODE
A library type indicating the library contains code.- See Also:
-
RESOURCE
A library type indicating the library contains resource files.- See Also:
-
-
Method Details
-
getContentFilters
String[] getContentFilters()Returns optional context filters that should be applied to calculate what classes to export from this library.- Returns:
- an array of content filter strings
-
getPackages
String[] getPackages()Returns optional package prefixes that can be used to make library lookup faster..- Returns:
- an array of package prefixes
-
isExported
boolean isExported()Returns true if this library contains types that will be visible to other plug-ins.- Returns:
- true if there are exported types in the library
-
isFullyExported
boolean isFullyExported()Returns true if all the types in this library will be visible to other plug-ins.- Returns:
- true if all the types are exported in the library
-
getType
String getType()- Returns:
- The type of this library
-
setContentFilters
Sets the optional content filters for this library. This method may throw a CoreException if the model is not editable.- Parameters:
filters- an array of filter strings- Throws:
CoreException- if the model is not editable
-
addContentFilter
Export a particular package in a library. This method may throw a CoreException if the model is not editable.- Parameters:
filter- a package name- Throws:
CoreException- if the model is not editable
-
removeContentFilter
Remove a package from the export list. This method may throw a CoreException if the model is not editable.- Parameters:
filter- a package name- Throws:
CoreException- if the model is not editable
-
setPackages
Sets the optional package prefixes for this library. This method may throw a CoreException if the model is not editable.- Parameters:
packages- an array of package prefixes- Throws:
CoreException- if the model is not editable
-
setExported
Sets whether types in this library will be visible to other plug-ins. This method may throw a CoreException if the model is not editable.- Parameters:
value- whether the types in the library should be exported- Throws:
CoreException- if the model is not editable
-
setType
- Parameters:
type- The library type- Throws:
CoreException- if the model is not editable.
-