org.java.plugin.registry.xml
Class ExtensionPointImpl.ParameterDefinitionImpl

java.lang.Object
  extended by org.java.plugin.registry.xml.ExtensionPointImpl.ParameterDefinitionImpl
All Implemented Interfaces:
Documentable<ExtensionPoint.ParameterDefinition>, ExtensionPoint.ParameterDefinition, Identity, PluginElement<ExtensionPoint.ParameterDefinition>
Enclosing class:
ExtensionPointImpl

public class ExtensionPointImpl.ParameterDefinitionImpl
extends java.lang.Object
implements ExtensionPoint.ParameterDefinition


Field Summary
protected  org.apache.commons.logging.Log log
          Makes logging service available for descending classes.
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 java.lang.String getCustomData()
           
 ExtensionPoint getDeclaringExtensionPoint()
           
 PluginDescriptor getDeclaringPluginDescriptor()
          Returns plug-in descriptor, this element belongs to.
 PluginFragment getDeclaringPluginFragment()
          Returns descriptor of plug-in fragment that contributes this element.
 java.lang.String getDefaultValue()
           
 java.lang.String getDocsPath()
           
 Documentation<T> getDocumentation()
           
 java.lang.String getId()
           
 ParameterMultiplicity getMultiplicity()
           
 ExtensionPoint.ParameterDefinition getSubDefinition(java.lang.String id)
           
 java.util.Collection<ExtensionPoint.ParameterDefinition> getSubDefinitions()
          Returns collection of all parameter sub-definitions declared in this parameter definition.
 ExtensionPoint.ParameterDefinition getSuperDefinition()
           
 ParameterType getType()
           
 ParameterValueParser getValueParser()
           
 int hashCode()
           
protected  boolean isEqualTo(Identity idt)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
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
 

Field Detail

log

protected final org.apache.commons.logging.Log log
Makes logging service available for descending classes.

Method Detail

getValueParser

public ParameterValueParser getValueParser()

getDeclaringExtensionPoint

public ExtensionPoint getDeclaringExtensionPoint()
Specified by:
getDeclaringExtensionPoint in interface ExtensionPoint.ParameterDefinition
Returns:
extension point, this definition belongs to
See Also:
#getDeclaringExtensionPoint()

getMultiplicity

public ParameterMultiplicity getMultiplicity()
Specified by:
getMultiplicity in interface ExtensionPoint.ParameterDefinition
Returns:
multiplicity of parameter, that can be defined according to this definition
See Also:
#getMultiplicity()

getSubDefinitions

public java.util.Collection<ExtensionPoint.ParameterDefinition> getSubDefinitions()
Description copied from interface: ExtensionPoint.ParameterDefinition
Returns collection of all parameter sub-definitions declared in this parameter definition.

Specified by:
getSubDefinitions in interface ExtensionPoint.ParameterDefinition
Returns:
collection of ExtensionPoint.ParameterDefinition objects
See Also:
#getSubDefinitions()

getSuperDefinition

public ExtensionPoint.ParameterDefinition getSuperDefinition()
Specified by:
getSuperDefinition in interface ExtensionPoint.ParameterDefinition
Returns:
parameter definition, of which this one is child or null if this is top level parameter definition
See Also:
#getSuperDefinition()

getSubDefinition

public ExtensionPoint.ParameterDefinition getSubDefinition(java.lang.String id)
Specified by:
getSubDefinition in interface ExtensionPoint.ParameterDefinition
Parameters:
id - ID of parameter sub-definition to look for
Returns:
parameter sub-definition with given ID
See Also:
#getSubDefinition(java.lang.String)

getType

public ParameterType getType()
Specified by:
getType in interface ExtensionPoint.ParameterDefinition
Returns:
value type of parameter, that can be defined according to this definition
See Also:
ExtensionPoint.ParameterDefinition.getType()

getCustomData

public java.lang.String getCustomData()
Specified by:
getCustomData in interface ExtensionPoint.ParameterDefinition
Returns:
custom data for additional customization of some types
See Also:
#getCustomData()

getDefaultValue

public java.lang.String getDefaultValue()
Specified by:
getDefaultValue in interface ExtensionPoint.ParameterDefinition
Returns:
default parameter value as it is defined in manifest
See Also:
#getDefaultValue()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object
See Also:
Object.toString()

isEqualTo

protected boolean isEqualTo(Identity idt)
See Also:
IdentityImpl.isEqualTo( org.java.plugin.registry.Identity)

getDeclaringPluginDescriptor

public PluginDescriptor getDeclaringPluginDescriptor()
Description copied from interface: PluginElement
Returns plug-in descriptor, this element belongs to. This method should never return null.

Specified by:
getDeclaringPluginDescriptor in interface PluginElement<T extends PluginElement<T>>
Returns:
plug-in descriptor, this element belongs to
See Also:
PluginElement.getDeclaringPluginDescriptor()

getDeclaringPluginFragment

public PluginFragment getDeclaringPluginFragment()
Description copied from interface: PluginElement
Returns descriptor of plug-in fragment that contributes this element. This method may return null, if element is contributed by plug-in directly.

Specified by:
getDeclaringPluginFragment in interface PluginElement<T extends PluginElement<T>>
Returns:
descriptor of plug-in fragment that contributes this element
See Also:
PluginElement.getDeclaringPluginFragment()

getDocumentation

public Documentation<T> getDocumentation()
Specified by:
getDocumentation in interface Documentable<T extends PluginElement<T>>
Returns:
plug-in element documentation object or null if there is no documentation provided
See Also:
Documentable.getDocumentation()

getDocsPath

public java.lang.String getDocsPath()
Specified by:
getDocsPath in interface Documentable<T extends PluginElement<T>>
Returns:
path to documentation "home", it is used for resolving documentation references
See Also:
Documentable.getDocsPath()

getId

public java.lang.String getId()
Specified by:
getId in interface Identity
Returns:
ID of plug-in manifest element
See Also:
Identity.getId()

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object
See Also:
Object.equals(java.lang.Object)

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object
See Also:
Object.hashCode()


Copyright © 2010. All Rights Reserved.