Package org.java.plugin.registry
Interface PluginDescriptor
-
- All Superinterfaces:
Documentable<PluginDescriptor>
,Identity
,UniqueIdentity
- All Known Implementing Classes:
MockPluginDescriptor
public interface PluginDescriptor extends UniqueIdentity, Documentable<PluginDescriptor>
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:
- plug-in DTD for standard
registry implementation,
PluginRegistry
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description PluginAttribute
getAttribute(java.lang.String id)
java.util.Collection<PluginAttribute>
getAttributes()
Returns collection of all top level attributes defined in manifest.java.util.Collection<PluginAttribute>
getAttributes(java.lang.String id)
Extension
getExtension(java.lang.String id)
ExtensionPoint
getExtensionPoint(java.lang.String id)
java.util.Collection<ExtensionPoint>
getExtensionPoints()
Returns collection of all extension points defined in manifest.java.util.Collection<Extension>
getExtensions()
Returns collection of all extensions defined in manifest.java.util.Collection<PluginFragment>
getFragments()
Returns collection of plug-in fragments which contributes to this plug-in.java.util.Collection<Library>
getLibraries()
Returns collection of all libraries defined in manifest.Library
getLibrary(java.lang.String id)
java.net.URL
getLocation()
java.lang.String
getPluginClassName()
PluginPrerequisite
getPrerequisite(java.lang.String id)
java.util.Collection<PluginPrerequisite>
getPrerequisites()
Returns collection of all prerequisites defined in manifest.PluginRegistry
getRegistry()
java.lang.String
getVendor()
Version
getVersion()
-
Methods inherited from interface org.java.plugin.registry.Documentable
getDocsPath, getDocumentation
-
Methods inherited from interface org.java.plugin.registry.UniqueIdentity
getUniqueId
-
-
-
-
Method Detail
-
getVendor
java.lang.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
java.util.Collection<PluginAttribute> getAttributes()
Returns collection of all top level attributes defined in manifest.- Returns:
- collection of
PluginAttribute
objects
-
getAttribute
PluginAttribute getAttribute(java.lang.String id)
- Parameters:
id
- ID of attribute to look for- Returns:
- top level attribute with given ID
-
getAttributes
java.util.Collection<PluginAttribute> getAttributes(java.lang.String id)
- Parameters:
id
- ID of attribute to look for- Returns:
- collection of all top level attributes with given ID
-
getPrerequisites
java.util.Collection<PluginPrerequisite> getPrerequisites()
Returns collection of all prerequisites defined in manifest.- Returns:
- collection of
PluginPrerequisite
objects
-
getPrerequisite
PluginPrerequisite getPrerequisite(java.lang.String id)
- Parameters:
id
- prerequisite ID- Returns:
- plug-in prerequisite object instance or
null
-
getExtensionPoints
java.util.Collection<ExtensionPoint> getExtensionPoints()
Returns collection of all extension points defined in manifest.- Returns:
- collection of
ExtensionPoint
objects
-
getExtensionPoint
ExtensionPoint getExtensionPoint(java.lang.String id)
- Parameters:
id
- extension point ID- Returns:
- extension point object or
null
-
getExtensions
java.util.Collection<Extension> getExtensions()
Returns collection of all extensions defined in manifest.- Returns:
- collection of
Extension
objects
-
getExtension
Extension getExtension(java.lang.String id)
- Parameters:
id
- extension ID- Returns:
- extension object or
null
-
getLibraries
java.util.Collection<Library> getLibraries()
Returns collection of all libraries defined in manifest.- Returns:
- collection of
Library
objects
-
getLibrary
Library getLibrary(java.lang.String id)
- Parameters:
id
- library ID- Returns:
- library object or
null
-
getRegistry
PluginRegistry getRegistry()
- Returns:
- plug-ins registry
-
getPluginClassName
java.lang.String getPluginClassName()
- Returns:
- plug-in class name as specified in manifest file or
null
-
getFragments
java.util.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
java.net.URL getLocation()
- Returns:
- location from which this plug-in was registered
-
-