Package org.java.plugin.registry
Interface ExtensionPoint.ParameterDefinition
-
- All Superinterfaces:
Documentable<ExtensionPoint.ParameterDefinition>
,Identity
,PluginElement<ExtensionPoint.ParameterDefinition>
- All Known Implementing Classes:
MockParameterDefinition
- Enclosing interface:
- ExtensionPoint
public static interface ExtensionPoint.ParameterDefinition extends PluginElement<ExtensionPoint.ParameterDefinition>
This interface abstracts parameter definition - a parameter "type declaration".- Version:
- $Id$
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getCustomData()
ExtensionPoint
getDeclaringExtensionPoint()
java.lang.String
getDefaultValue()
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()
-
Methods inherited from interface org.java.plugin.registry.Documentable
getDocsPath, getDocumentation
-
Methods inherited from interface org.java.plugin.registry.PluginElement
getDeclaringPluginDescriptor, getDeclaringPluginFragment
-
-
-
-
Method Detail
-
getMultiplicity
ParameterMultiplicity getMultiplicity()
- Returns:
- multiplicity of parameter, that can be defined according to this definition
-
getType
ParameterType getType()
- Returns:
- value type of parameter, that can be defined according to this definition
-
getCustomData
java.lang.String getCustomData()
- Returns:
- custom data for additional customization of some types
-
getSubDefinitions
java.util.Collection<ExtensionPoint.ParameterDefinition> getSubDefinitions()
Returns collection of all parameter sub-definitions declared in this parameter definition.- Returns:
- collection of
ExtensionPoint.ParameterDefinition
objects
-
getSubDefinition
ExtensionPoint.ParameterDefinition getSubDefinition(java.lang.String id)
- Parameters:
id
- ID of parameter sub-definition to look for- Returns:
- parameter sub-definition with given ID
-
getDeclaringExtensionPoint
ExtensionPoint getDeclaringExtensionPoint()
- Returns:
- extension point, this definition belongs to
-
getSuperDefinition
ExtensionPoint.ParameterDefinition getSuperDefinition()
- Returns:
- parameter definition, of which this one is child or
null
if this is top level parameter definition
-
getDefaultValue
java.lang.String getDefaultValue()
- Returns:
- default parameter value as it is defined in manifest
-
-