org.java.plugin.registry

Interface Extension

All Superinterfaces:

Documentable<Extension>, Identity, PluginElement<Extension>, UniqueIdentity

All Known Implementing Classes:

MockExtension

public interface Extension
extends UniqueIdentity, PluginElement<Extension>

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 Classes

Modifier and Type	Interface and Description
static interface	Extension.Parameter This interface abstracts extension parameter according to extension declaration in manifest.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getExtendedPluginId()
java.lang.String	getExtendedPointId()
Extension.Parameter	getParameter(java.lang.String id) Returns top level parameter with given ID or null if no top level parameters exist.
java.util.Collection<Extension.Parameter>	getParameters() Returns collection of all top level parameters defined in this extension.
java.util.Collection<Extension.Parameter>	getParameters(java.lang.String id)
boolean	isValid()

Methods inherited from interface org.java.plugin.registry.UniqueIdentity

getUniqueId

Methods inherited from interface org.java.plugin.registry.PluginElement

getDeclaringPluginDescriptor, getDeclaringPluginFragment

Methods inherited from interface org.java.plugin.registry.Identity

getId

Methods inherited from interface org.java.plugin.registry.Documentable

getDocsPath, getDocumentation

Method Detail

getParameters

java.util.Collection<Extension.Parameter> getParameters()

Returns collection of all top level parameters defined in this extension.

Returns:

collection of Extension.Parameter objects

getParameter

Extension.Parameter getParameter(java.lang.String id)

Returns top level parameter with given ID or null if no top level parameters exist. If more than one top level parameters with given ID found, the method should throw an IllegalArgumentException.

Parameters:

id - ID of parameter to look for

Returns:

top level parameter with given ID

getParameters

java.util.Collection<Extension.Parameter> getParameters(java.lang.String id)

Parameters:

id - ID of parameter to look for

Returns:

collection of all top level parameters with given ID

getExtendedPluginId

java.lang.String getExtendedPluginId()

Returns:

ID of plug-in, extended point belongs to

getExtendedPointId

java.lang.String getExtendedPointId()

Returns:

ID of extended point

isValid

boolean isValid()

Returns:

true if extension is considered to be valid