JPF 0.10

org.java.plugin.registry
Interface ExtensionPoint

All Superinterfaces:
Documentable, Identity, PluginElement, UniqueIdentity

public interface ExtensionPoint
extends UniqueIdentity, PluginElement

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: ExtensionPoint.java,v 1.3 2006/04/09 10:01:45 ddimon Exp $

Nested Class Summary
static interface ExtensionPoint.ParameterDefinition
          This interface abstracts parameter definition - a parameter "type declaration".
 
Field Summary
static java.lang.String EXT_MULT_ANY
          Extension point multiplicity constant.
static java.lang.String EXT_MULT_NONE
          Extension point multiplicity constant.
static java.lang.String EXT_MULT_ONE
          Extension point multiplicity constant.
static java.lang.String EXT_MULT_ONE_PER_PLUGIN
          Extension point multiplicity constant.
 
Method Summary
 Extension getAvailableExtension(java.lang.String uniqueId)
           
 java.util.Collection getAvailableExtensions()
          Returns a collection of all extensions that available for this point.
 Extension getConnectedExtension(java.lang.String uniqueId)
           
 java.util.Collection getConnectedExtensions()
          Returns a collection of all extensions that was successfully "connected" to this point.
 java.util.Collection getDescendants()
          Looks for all available (valid) successors of this extension point.
 java.lang.String getMultiplicity()
           
 ExtensionPoint.ParameterDefinition getParameterDefinition(java.lang.String id)
           
 java.util.Collection 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.Identity
getId
 
Methods inherited from interface org.java.plugin.registry.PluginElement
getDeclaringPluginDescriptor, getDeclaringPluginFragment
 
Methods inherited from interface org.java.plugin.registry.Documentable
getDocsPath, getDocumentation
 

Field Detail

EXT_MULT_ANY

public static final java.lang.String EXT_MULT_ANY
Extension point multiplicity constant.

See Also:
Constant Field Values

EXT_MULT_ONE

public static final java.lang.String EXT_MULT_ONE
Extension point multiplicity constant.

See Also:
Constant Field Values

EXT_MULT_ONE_PER_PLUGIN

public static final java.lang.String EXT_MULT_ONE_PER_PLUGIN
Extension point multiplicity constant.

See Also:
Constant Field Values

EXT_MULT_NONE

public static final java.lang.String EXT_MULT_NONE
Extension point multiplicity constant.

See Also:
Constant Field Values
Method Detail

getMultiplicity

public java.lang.String getMultiplicity()
Returns:
multiplicity of this extension point

getParameterDefinitions

public java.util.Collection 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

public ExtensionPoint.ParameterDefinition getParameterDefinition(java.lang.String id)
Parameters:
id - ID of parameter definition to look for
Returns:
parameter definition with given ID

getAvailableExtensions

public java.util.Collection getAvailableExtensions()
Returns a collection of all extensions that available for this point.

Returns:
collection of Extension objects

getAvailableExtension

public Extension getAvailableExtension(java.lang.String uniqueId)
Parameters:
uniqueId - unique ID of extension
Returns:
extension that is available for this point

isExtensionAvailable

public 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

public java.util.Collection getConnectedExtensions()
Returns a collection of all extensions that was successfully "connected" to this point.

Returns:
collection of Extension objects

getConnectedExtension

public Extension getConnectedExtension(java.lang.String uniqueId)
Parameters:
uniqueId - unique ID of extension
Returns:
extension that was successfully "connected" to this point

isExtensionConnected

public 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

public boolean isValid()
Returns:
true if extension point is considered to be valid

getParentPluginId

public java.lang.String getParentPluginId()
Returns:
parent extension point plug-in ID or null

getParentExtensionPointId

public java.lang.String getParentExtensionPointId()
Returns:
parent extension point ID or null

isSuccessorOf

public boolean isSuccessorOf(ExtensionPoint extensionPoint)
Parameters:
extensionPoint - extension point
Returns:
true if this point is successor of given extension point

getDescendants

public java.util.Collection 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

JPF 0.10

Copyright © 2004-2005 Dmitry Olshansky. All Rights Reserved.