Package org.eclipse.pde.core.plugin
Interface IPluginBase
-
- All Superinterfaces:
IAdaptable,IExtensions,IIdentifiable,IPluginObject,IWritable
public interface IPluginBase extends IExtensions, IIdentifiable
A model object that represents the content of a plug-in or fragment manifest. This object contains data that is common for both plug-ins and fragments.- Restriction:
- This interface is not intended to be implemented by clients.
- Restriction:
- This interface is not intended to be extended by clients.
-
-
Field Summary
Fields Modifier and Type Field Description static StringP_IMPORT_ORDERA property that will be used to notify that import order in a plug-in has changed.static StringP_LIBRARY_ORDERA property that will be used to notify that library order in a plug-in has changed.static StringP_PROVIDERA property that will be used to notify that the provider name has changed.static StringP_SCHEMA_VERSIONA property that will be used to notify that 3.0 release compatibility flag has been changed.static StringP_VERSIONA property that will be used to notify that a version has changed.-
Fields inherited from interface org.eclipse.pde.core.plugin.IExtensions
P_EXTENSION_ORDER
-
Fields inherited from interface org.eclipse.pde.core.IIdentifiable
P_ID
-
Fields inherited from interface org.eclipse.pde.core.plugin.IPluginObject
P_NAME
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidadd(IPluginImport pluginImport)Adds a new plug-in import to this plugin.voidadd(IPluginLibrary library)Adds a new library to this plugin.IPluginImport[]getImports()Returns imports defined in this plug-in.IPluginLibrary[]getLibraries()Returns libraries referenced in this plug-in.StringgetProviderName()Returns a name of the plug-in provider.StringgetSchemaVersion()Returns version of the manifest grammarStringgetVersion()Returns this plug-in's versionvoidremove(IPluginImport pluginImport)Removes an import from the plugin.voidremove(IPluginLibrary library)Removes a library from the plugin.voidsetProviderName(String providerName)Sets the name of the plug-in provider.voidsetSchemaVersion(String schemaVersion)Sets the R3.0 compatibility flagvoidsetVersion(String version)Sets the version of the plug-in.voidswap(IPluginImport import1, IPluginImport import2)Swaps the positions of the plug-ins provided in in the dependency list.voidswap(IPluginLibrary l1, IPluginLibrary l2)Swaps the positions of the provided libraries in the list of libraries.-
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
-
Methods inherited from interface org.eclipse.pde.core.plugin.IExtensions
add, add, getExtensionPoints, getExtensions, getIndexOf, remove, remove, swap
-
Methods inherited from interface org.eclipse.pde.core.IIdentifiable
getId, setId
-
Methods inherited from interface org.eclipse.pde.core.plugin.IPluginObject
getModel, getName, getParent, getPluginBase, getPluginModel, getResourceString, getTranslatedName, isInTheModel, isValid, setInTheModel, setName
-
-
-
-
Field Detail
-
P_PROVIDER
static final String P_PROVIDER
A property that will be used to notify that the provider name has changed.- See Also:
- Constant Field Values
-
P_VERSION
static final String P_VERSION
A property that will be used to notify that a version has changed.- See Also:
- Constant Field Values
-
P_LIBRARY_ORDER
static final String P_LIBRARY_ORDER
A property that will be used to notify that library order in a plug-in has changed.- See Also:
- Constant Field Values
-
P_IMPORT_ORDER
static final String P_IMPORT_ORDER
A property that will be used to notify that import order in a plug-in has changed.- See Also:
- Constant Field Values
-
P_SCHEMA_VERSION
static final String P_SCHEMA_VERSION
A property that will be used to notify that 3.0 release compatibility flag has been changed.- See Also:
- Constant Field Values
-
-
Method Detail
-
add
void add(IPluginLibrary library) throws CoreException
Adds a new library to this plugin. This method will throw a CoreException if model is not editable.- Parameters:
library- the new library- Throws:
CoreException- if the model is not editable
-
add
void add(IPluginImport pluginImport) throws CoreException
Adds a new plug-in import to this plugin. This method will throw a CoreException if model is not editable.- Parameters:
pluginImport- the new import object- Throws:
CoreException- if the model is not editable
-
remove
void remove(IPluginImport pluginImport) throws CoreException
Removes an import from the plugin. This method will throw a CoreException if the model is not editable.- Parameters:
pluginImport- the import object- Throws:
CoreException- if the model is not editable
-
getLibraries
IPluginLibrary[] getLibraries()
Returns libraries referenced in this plug-in.- Returns:
- an array of libraries
-
getImports
IPluginImport[] getImports()
Returns imports defined in this plug-in.- Returns:
- an array of import objects
-
getProviderName
String getProviderName()
Returns a name of the plug-in provider.- Returns:
- plug-in provider name
-
getVersion
String getVersion()
Returns this plug-in's version- Returns:
- the version of the plug-in
-
remove
void remove(IPluginLibrary library) throws CoreException
Removes a library from the plugin. This method will throw a CoreException if the model is not editable.- Parameters:
library- the library object- Throws:
CoreException- if the model is not editable
-
setProviderName
void setProviderName(String providerName) throws CoreException
Sets the name of the plug-in provider. This method will throw a CoreException if the model is not editable.- Parameters:
providerName- the new provider name- Throws:
CoreException- if the model is not editable
-
setVersion
void setVersion(String version) throws CoreException
Sets the version of the plug-in. This method will throw a CoreException if the model is not editable.- Parameters:
version- the new plug-in version- Throws:
CoreException- if the model is not editable
-
swap
void swap(IPluginLibrary l1, IPluginLibrary l2) throws CoreException
Swaps the positions of the provided libraries in the list of libraries. Libraries are looked up by the class loader in the order of declaration. If two libraries contain classes with the same name, library order will determine which one is encountered first.- Parameters:
l1- the first library objectl2- the second library object- Throws:
CoreException- if the model is not editable
-
swap
void swap(IPluginImport import1, IPluginImport import2) throws CoreException
Swaps the positions of the plug-ins provided in in the dependency list. This order is the one used used by the classloader when loading classes.- Parameters:
import1- the first import objectimport2- the second import object- Throws:
CoreException- if the model is not editable
-
getSchemaVersion
String getSchemaVersion()
Returns version of the manifest grammar- Returns:
- version of the manifest grammar, or null
-
setSchemaVersion
void setSchemaVersion(String schemaVersion) throws CoreException
Sets the R3.0 compatibility flag- Parameters:
schemaVersion- version of the manifest grammar- Throws:
CoreException- if the model is not editable
-
-