org.java.plugin.registry

Interface ExtensionPoint

All Superinterfaces:

Documentable<ExtensionPoint>, Identity, PluginElement<ExtensionPoint>, UniqueIdentity

All Known Implementing Classes:

MockExtensionPoint

public interface ExtensionPoint
extends UniqueIdentity, PluginElement<ExtensionPoint>

This interface abstracts the extension point - a place where the functionality of plug-in can be extended.

Extension point UID is a combination of declaring plug-in ID and extension point 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	ExtensionPoint.ParameterDefinition This interface abstracts parameter definition - a parameter "type declaration".

Method Summary

Methods

Modifier and Type	Method and Description
Extension	getAvailableExtension(java.lang.String uniqueId)
java.util.Collection<Extension>	getAvailableExtensions() Returns a collection of all extensions that available for this point.
Extension	getConnectedExtension(java.lang.String uniqueId)
java.util.Collection<Extension>	getConnectedExtensions() Returns a collection of all extensions that was successfully "connected" to this point.
java.util.Collection<ExtensionPoint>	getDescendants() Looks for all available (valid) successors of this extension point.
ExtensionMultiplicity	getMultiplicity()
ExtensionPoint.ParameterDefinition	getParameterDefinition(java.lang.String id)
java.util.Collection<ExtensionPoint.ParameterDefinition>	getParameterDefinitions() Returns collection of all top level parameter definitions declared in this extension point and all it parents.
java.lang.String	getParentExtensionPointId()
java.lang.String	getParentPluginId()
boolean	isExtensionAvailable(java.lang.String uniqueId) Checks if extension is available for this extension point.
boolean	isExtensionConnected(java.lang.String uniqueId) Checks if extension is in valid state and successfully "connected" to this extension point.
boolean	isSuccessorOf(ExtensionPoint extensionPoint)
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

getMultiplicity

ExtensionMultiplicity getMultiplicity()

Returns:

multiplicity of this extension point

getParameterDefinitions

java.util.Collection<ExtensionPoint.ParameterDefinition> getParameterDefinitions()

Returns collection of all top level parameter definitions declared in this extension point and all it parents.

Returns:

collection of ExtensionPoint.ParameterDefinition objects

getParameterDefinition

ExtensionPoint.ParameterDefinition getParameterDefinition(java.lang.String id)

Parameters:

id - ID of parameter definition to look for

Returns:

parameter definition with given ID

getAvailableExtensions

java.util.Collection<Extension> getAvailableExtensions()

Returns a collection of all extensions that available for this point.

Returns:

collection of Extension objects

getAvailableExtension

Extension getAvailableExtension(java.lang.String uniqueId)

Parameters:

uniqueId - unique ID of extension

Returns:

extension that is available for this point

isExtensionAvailable

boolean isExtensionAvailable(java.lang.String uniqueId)

Checks if extension is available for this extension point. If this method returns true, the method getAvailableExtension(String) should return valid extension for the same UID.

Parameters:

uniqueId - unique ID of extension

Returns:

true if extension is available for this extension point

getConnectedExtensions

java.util.Collection<Extension> getConnectedExtensions()

Returns a collection of all extensions that was successfully "connected" to this point.

Returns:

collection of Extension objects

getConnectedExtension

Extension getConnectedExtension(java.lang.String uniqueId)

Parameters:

uniqueId - unique ID of extension

Returns:

extension that was successfully "connected" to this point

isExtensionConnected

boolean isExtensionConnected(java.lang.String uniqueId)

Checks if extension is in valid state and successfully "connected" to this extension point. If this method returns true, the method getConnectedExtension(String) should return valid extension for the same UID.

Parameters:

uniqueId - unique ID of extension

Returns:

true if extension was successfully "connected" to this extension point

isValid

boolean isValid()

Returns:

true if extension point is considered to be valid

getParentPluginId

java.lang.String getParentPluginId()

Returns:

parent extension point plug-in ID or null

getParentExtensionPointId

java.lang.String getParentExtensionPointId()

Returns:

parent extension point ID or null

isSuccessorOf

boolean isSuccessorOf(ExtensionPoint extensionPoint)

Parameters:

extensionPoint - extension point

Returns:

true if this point is successor of given extension point

getDescendants

java.util.Collection<ExtensionPoint> getDescendants()

Looks for all available (valid) successors of this extension point. The search should be done recursively including all descendants of this extension point.

Returns:

collection of ExtensionPoint objects