Package org.java.plugin.tools.mocks
Class MockExtensionPoint
- java.lang.Object
-
- org.java.plugin.tools.mocks.MockIdentity
-
- org.java.plugin.tools.mocks.MockPluginElement<ExtensionPoint>
-
- org.java.plugin.tools.mocks.MockExtensionPoint
-
- All Implemented Interfaces:
Documentable<ExtensionPoint>,ExtensionPoint,Identity,PluginElement<ExtensionPoint>,UniqueIdentity
public class MockExtensionPoint extends MockPluginElement<ExtensionPoint> implements ExtensionPoint
- Version:
- $Id$
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.java.plugin.registry.ExtensionPoint
ExtensionPoint.ParameterDefinition
-
-
Constructor Summary
Constructors Constructor Description MockExtensionPoint()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MockExtensionPointaddExtension(Extension extension, boolean isConnected)MockExtensionPointaddParameter(ExtensionPoint extensionPoint)MockExtensionPointaddParameterDefinition(ExtensionPoint.ParameterDefinition parameterDefinition)MockExtensionPointaddPredecessors(java.lang.String pluginId, java.lang.String extensionPointId)ExtensiongetAvailableExtension(java.lang.String uniqueId)java.util.Collection<Extension>getAvailableExtensions()Returns a collection of all extensions that available for this point.ExtensiongetConnectedExtension(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.ExtensionMultiplicitygetMultiplicity()ExtensionPoint.ParameterDefinitiongetParameterDefinition(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.StringgetParentExtensionPointId()java.lang.StringgetParentPluginId()java.lang.StringgetUniqueId()booleanisExtensionAvailable(java.lang.String uniqueId)Checks if extension is available for this extension point.booleanisExtensionConnected(java.lang.String uniqueId)Checks if extension is in valid state and successfully "connected" to this extension point.booleanisSuccessorOf(ExtensionPoint extensionPoint)booleanisValid()MockExtensionPointsetMultiplicity(ExtensionMultiplicity value)MockExtensionPointsetParentExtensionPoint(java.lang.String pluginId, java.lang.String extensionPointId)MockExtensionPointsetValid(boolean value)-
Methods inherited from class org.java.plugin.tools.mocks.MockPluginElement
getDeclaringPluginDescriptor, getDeclaringPluginFragment, getDocsPath, getDocumentation, setDeclaringPluginDescriptor, setDeclaringPluginFragment, setDocsPath, setDocumentation
-
Methods inherited from class org.java.plugin.tools.mocks.MockIdentity
getId, setId
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.java.plugin.registry.Documentable
getDocsPath, getDocumentation
-
Methods inherited from interface org.java.plugin.registry.PluginElement
getDeclaringPluginDescriptor, getDeclaringPluginFragment
-
-
-
-
Method Detail
-
getAvailableExtension
public Extension getAvailableExtension(java.lang.String uniqueId)
- Specified by:
getAvailableExtensionin interfaceExtensionPoint- Parameters:
uniqueId- unique ID of extension- Returns:
- extension that is available for this point
- See Also:
ExtensionPoint.getAvailableExtension( java.lang.String)
-
getAvailableExtensions
public java.util.Collection<Extension> getAvailableExtensions()
Description copied from interface:ExtensionPointReturns a collection of all extensions that available for this point.- Specified by:
getAvailableExtensionsin interfaceExtensionPoint- Returns:
- collection of
Extensionobjects - See Also:
ExtensionPoint.getAvailableExtensions()
-
getConnectedExtension
public Extension getConnectedExtension(java.lang.String uniqueId)
- Specified by:
getConnectedExtensionin interfaceExtensionPoint- Parameters:
uniqueId- unique ID of extension- Returns:
- extension that was successfully "connected" to this point
- See Also:
ExtensionPoint.getConnectedExtension( java.lang.String)
-
getConnectedExtensions
public java.util.Collection<Extension> getConnectedExtensions()
Description copied from interface:ExtensionPointReturns a collection of all extensions that was successfully "connected" to this point.- Specified by:
getConnectedExtensionsin interfaceExtensionPoint- Returns:
- collection of
Extensionobjects - See Also:
ExtensionPoint.getConnectedExtensions()
-
addExtension
public MockExtensionPoint addExtension(Extension extension, boolean isConnected)
- Parameters:
extension- extension to addisConnected- iftrueextension will be marked as "connected" also- Returns:
- this instance
-
getDescendants
public java.util.Collection<ExtensionPoint> getDescendants()
Description copied from interface:ExtensionPointLooks for all available (valid) successors of this extension point. The search should be done recursively including all descendants of this extension point.- Specified by:
getDescendantsin interfaceExtensionPoint- Returns:
- collection of
ExtensionPointobjects - See Also:
ExtensionPoint.getDescendants()
-
addParameter
public MockExtensionPoint addParameter(ExtensionPoint extensionPoint)
- Parameters:
extensionPoint- descendant extension to add- Returns:
- this instance
-
getMultiplicity
public ExtensionMultiplicity getMultiplicity()
- Specified by:
getMultiplicityin interfaceExtensionPoint- Returns:
- multiplicity of this extension point
- See Also:
ExtensionPoint.getMultiplicity()
-
setMultiplicity
public MockExtensionPoint setMultiplicity(ExtensionMultiplicity value)
- Parameters:
value- the multiplicity to set- Returns:
- this instance
-
getParameterDefinition
public ExtensionPoint.ParameterDefinition getParameterDefinition(java.lang.String id)
- Specified by:
getParameterDefinitionin interfaceExtensionPoint- Parameters:
id- ID of parameter definition to look for- Returns:
- parameter definition with given ID
- See Also:
ExtensionPoint.getParameterDefinition( java.lang.String)
-
getParameterDefinitions
public java.util.Collection<ExtensionPoint.ParameterDefinition> getParameterDefinitions()
Description copied from interface:ExtensionPointReturns collection of all top level parameter definitions declared in this extension point and all it parents.- Specified by:
getParameterDefinitionsin interfaceExtensionPoint- Returns:
- collection of
ExtensionPoint.ParameterDefinitionobjects - See Also:
ExtensionPoint.getParameterDefinitions()
-
addParameterDefinition
public MockExtensionPoint addParameterDefinition(ExtensionPoint.ParameterDefinition parameterDefinition)
- Parameters:
parameterDefinition- parameter definition to add- Returns:
- this instance
-
getParentExtensionPointId
public java.lang.String getParentExtensionPointId()
- Specified by:
getParentExtensionPointIdin interfaceExtensionPoint- Returns:
- parent extension point ID or
null - See Also:
ExtensionPoint.getParentExtensionPointId()
-
setParentExtensionPoint
public MockExtensionPoint setParentExtensionPoint(java.lang.String pluginId, java.lang.String extensionPointId)
- Parameters:
pluginId- the parent plug-in id to setextensionPointId- the parent extension point id to set- Returns:
- this instance
-
getParentPluginId
public java.lang.String getParentPluginId()
- Specified by:
getParentPluginIdin interfaceExtensionPoint- Returns:
- parent extension point plug-in ID or
null - See Also:
ExtensionPoint.getParentPluginId()
-
isExtensionAvailable
public boolean isExtensionAvailable(java.lang.String uniqueId)
Description copied from interface:ExtensionPointChecks if extension is available for this extension point. If this method returnstrue, the methodExtensionPoint.getAvailableExtension(String)should return valid extension for the same UID.- Specified by:
isExtensionAvailablein interfaceExtensionPoint- Parameters:
uniqueId- unique ID of extension- Returns:
trueif extension is available for this extension point- See Also:
ExtensionPoint.isExtensionAvailable( java.lang.String)
-
isExtensionConnected
public boolean isExtensionConnected(java.lang.String uniqueId)
Description copied from interface:ExtensionPointChecks if extension is in valid state and successfully "connected" to this extension point. If this method returnstrue, the methodExtensionPoint.getConnectedExtension(String)should return valid extension for the same UID.- Specified by:
isExtensionConnectedin interfaceExtensionPoint- Parameters:
uniqueId- unique ID of extension- Returns:
trueif extension was successfully "connected" to this extension point- See Also:
ExtensionPoint.isExtensionConnected( java.lang.String)
-
isSuccessorOf
public boolean isSuccessorOf(ExtensionPoint extensionPoint)
- Specified by:
isSuccessorOfin interfaceExtensionPoint- Parameters:
extensionPoint- extension point- Returns:
trueif this point is successor of given extension point- See Also:
ExtensionPoint.isSuccessorOf( org.java.plugin.registry.ExtensionPoint)
-
addPredecessors
public MockExtensionPoint addPredecessors(java.lang.String pluginId, java.lang.String extensionPointId)
- Parameters:
pluginId- predecessor plug-in ID to addextensionPointId- predecessor extension point ID to add- Returns:
- this instance
-
isValid
public boolean isValid()
- Specified by:
isValidin interfaceExtensionPoint- Returns:
trueif extension point is considered to be valid- See Also:
ExtensionPoint.isValid()
-
setValid
public MockExtensionPoint setValid(boolean value)
- Parameters:
value- the valid flag to set- Returns:
- this instance
-
getUniqueId
public java.lang.String getUniqueId()
- Specified by:
getUniqueIdin interfaceUniqueIdentity- Returns:
- unique ID of plug-in element
- See Also:
UniqueIdentity.getUniqueId()
-
-