Package org.java.plugin.registry
Interface PluginDescriptor
- All Superinterfaces:
Documentable<PluginDescriptor>
,Identity
,UniqueIdentity
- All Known Implementing Classes:
MockPluginDescriptor
Main interface to get access to all meta-information for particular
plug-in, described in plug-in manifest file.
Plug-in UID is a combination of plug-in ID and version identifier that is unique within whole set of registered plug-ins.
- Version:
- $Id$
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptiongetAttribute
(String id) Returns collection of all top level attributes defined in manifest.getAttributes
(String id) getExtension
(String id) Returns collection of all extension points defined in manifest.Returns collection of all extensions defined in manifest.Returns collection of plug-in fragments which contributes to this plug-in.Returns collection of all libraries defined in manifest.getLibrary
(String id) Returns collection of all prerequisites defined in manifest.Methods inherited from interface org.java.plugin.registry.Documentable
getDocsPath, getDocumentation
Methods inherited from interface org.java.plugin.registry.UniqueIdentity
getUniqueId
-
Method Details
-
getVendor
String getVendor()- Returns:
- vendor as specified in manifest file or empty string
-
getVersion
Version getVersion()- Returns:
- plug-in version identifier as specified in manifest file
-
getAttributes
Collection<PluginAttribute> getAttributes()Returns collection of all top level attributes defined in manifest.- Returns:
- collection of
PluginAttribute
objects
-
getAttribute
- Parameters:
id
- ID of attribute to look for- Returns:
- top level attribute with given ID
-
getAttributes
- Parameters:
id
- ID of attribute to look for- Returns:
- collection of all top level attributes with given ID
-
getPrerequisites
Collection<PluginPrerequisite> getPrerequisites()Returns collection of all prerequisites defined in manifest.- Returns:
- collection of
PluginPrerequisite
objects
-
getPrerequisite
- Parameters:
id
- prerequisite ID- Returns:
- plug-in prerequisite object instance or
null
-
getExtensionPoints
Collection<ExtensionPoint> getExtensionPoints()Returns collection of all extension points defined in manifest.- Returns:
- collection of
ExtensionPoint
objects
-
getExtensionPoint
- Parameters:
id
- extension point ID- Returns:
- extension point object or
null
-
getExtensions
Collection<Extension> getExtensions()Returns collection of all extensions defined in manifest.- Returns:
- collection of
Extension
objects
-
getExtension
- Parameters:
id
- extension ID- Returns:
- extension object or
null
-
getLibraries
Collection<Library> getLibraries()Returns collection of all libraries defined in manifest.- Returns:
- collection of
Library
objects
-
getLibrary
- Parameters:
id
- library ID- Returns:
- library object or
null
-
getRegistry
PluginRegistry getRegistry()- Returns:
- plug-ins registry
-
getPluginClassName
String getPluginClassName()- Returns:
- plug-in class name as specified in manifest file or
null
-
getFragments
Collection<PluginFragment> getFragments()Returns collection of plug-in fragments which contributes to this plug-in. One plug-in fragment may contribute to several versions of the same plug-in, according to it's manifest.- Returns:
- collection of
PluginFragment
objects
-
getLocation
URL getLocation()- Returns:
- location from which this plug-in was registered
-