Package org.java.plugin.registry
Interface Extension
- All Superinterfaces:
Documentable<Extension>
,Identity
,PluginElement<Extension>
,UniqueIdentity
- All Known Implementing Classes:
MockExtension
This interface abstracts an extension - particular functionality,
the plug-in contribute to the system.
Extension UID is a combination of declaring plug-in ID and extension ID that is unique within whole set of registered plug-ins.
- Version:
- $Id$
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interface
This interface abstracts extension parameter according to extension declaration in manifest. -
Method Summary
Modifier and TypeMethodDescriptiongetParameter
(String id) Returns top level parameter with given ID ornull
if no top level parameters exist.Returns collection of all top level parameters defined in this extension.getParameters
(String id) boolean
isValid()
Methods inherited from interface org.java.plugin.registry.Documentable
getDocsPath, getDocumentation
Methods inherited from interface org.java.plugin.registry.PluginElement
getDeclaringPluginDescriptor, getDeclaringPluginFragment
Methods inherited from interface org.java.plugin.registry.UniqueIdentity
getUniqueId
-
Method Details
-
getParameters
Collection<Extension.Parameter> getParameters()Returns collection of all top level parameters defined in this extension.- Returns:
- collection of
Extension.Parameter
objects
-
getParameter
Returns top level parameter with given ID ornull
if no top level parameters exist. If more than one top level parameters with given ID found, the method should throw anIllegalArgumentException
.- Parameters:
id
- ID of parameter to look for- Returns:
- top level parameter with given ID
-
getParameters
- Parameters:
id
- ID of parameter to look for- Returns:
- collection of all top level parameters with given ID
-
getExtendedPluginId
String getExtendedPluginId()- Returns:
- ID of plug-in, extended point belongs to
-
getExtendedPointId
String getExtendedPointId()- Returns:
- ID of extended point
-
isValid
boolean isValid()- Returns:
true
if extension is considered to be valid
-