Package org.eclipse.pde.core.plugin
Interface IFragment
- All Superinterfaces:
IAdaptable,IExtensions,IIdentifiable,IPluginBase,IPluginObject,IWritable
A model object that represents the content of the fragment.xml
file.
- 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 property that will be used to notify that a plugin id has changed.static final StringA property that will be used to notify that a plugin version has changed.static final StringA property that will be used to notify that a plugin version match rule has changed.Fields inherited from interface org.eclipse.pde.core.plugin.IExtensions
P_EXTENSION_ORDERFields inherited from interface org.eclipse.pde.core.IIdentifiable
P_IDFields inherited from interface org.eclipse.pde.core.plugin.IPluginBase
P_IMPORT_ORDER, P_LIBRARY_ORDER, P_PROVIDER, P_SCHEMA_VERSION, P_VERSIONFields inherited from interface org.eclipse.pde.core.plugin.IPluginObject
P_NAME -
Method Summary
Modifier and TypeMethodDescriptionReturns the id of the fragment host.Returns the version of the fragment host.intgetRule()Returns an optional version match rule as defined in IMatchRule interface.voidsetPluginId(String id) Sets the id of the plug-in that will be the target of this fragment.voidsetPluginVersion(String version) Sets the version of the plug-in that will be the target of this fragment.'voidsetRule(int rule) Sets the optional version match rule as defined in IMatchRules.Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapterMethods inherited from interface org.eclipse.pde.core.plugin.IExtensions
add, add, getExtensionPoints, getExtensions, getIndexOf, remove, remove, swapMethods inherited from interface org.eclipse.pde.core.IIdentifiable
getId, setIdMethods inherited from interface org.eclipse.pde.core.plugin.IPluginBase
add, add, exportsExternalAnnotations, getImports, getLibraries, getProviderName, getSchemaVersion, getVersion, remove, remove, setProviderName, setSchemaVersion, setVersion, swap, swapMethods inherited from interface org.eclipse.pde.core.plugin.IPluginObject
getModel, getName, getParent, getPluginBase, getPluginModel, getResourceString, getTranslatedName, isInTheModel, isValid, setInTheModel, setName
-
Field Details
-
P_PLUGIN_ID
A property that will be used to notify that a plugin id has changed.- See Also:
-
P_PLUGIN_VERSION
A property that will be used to notify that a plugin version has changed.- See Also:
-
P_RULE
A property that will be used to notify that a plugin version match rule has changed.- See Also:
-
-
Method Details
-
getPluginId
String getPluginId()Returns the id of the fragment host.- Returns:
- the host id
-
getPluginVersion
String getPluginVersion()Returns the version of the fragment host.- Returns:
- the host version
-
getRule
int getRule()Returns an optional version match rule as defined in IMatchRule interface.- Returns:
- the match rule
-
setPluginId
Sets the id of the plug-in that will be the target of this fragment.- Parameters:
id- the id of the referenced plug-in.- Throws:
CoreException- attempts to modify a read-only fragment will result in an exception
-
setPluginVersion
Sets the version of the plug-in that will be the target of this fragment.'- Parameters:
version- the version of the referenced version.- Throws:
CoreException- attempts to modify a read-only fragment will result in an exception
-
setRule
Sets the optional version match rule as defined in IMatchRules. This rule will be used when attempting to match the referenced plug-in version.- Parameters:
rule- the match rule to be used when locating the referenced the plug-in.- Throws:
CoreException- attempts to modify a read-only fragment will result in an exception
-