JPF 0.10

org.java.plugin.registry
Interface ExtensionPoint.ParameterDefinition

All Superinterfaces:
Documentable, Identity, PluginElement
Enclosing interface:
ExtensionPoint

public static interface ExtensionPoint.ParameterDefinition
extends PluginElement

This interface abstracts parameter definition - a parameter "type declaration".

Version:
$Id: ExtensionPoint.java,v 1.3 2006/04/09 10:01:45 ddimon Exp $

Field Summary
static java.lang.String MULT_ANY
          Parameter definition multiplicity constant.
static java.lang.String MULT_NONE_OR_ONE
          Parameter definition multiplicity constant.
static java.lang.String MULT_ONE
          Parameter definition multiplicity constant.
static java.lang.String MULT_ONE_OR_MORE
          Parameter definition multiplicity constant.
static java.lang.String TYPE_ANY
          Parameter definition type constant.
static java.lang.String TYPE_BOOLEAN
          Parameter definition type constant.
static java.lang.String TYPE_DATE
          Parameter definition type constant.
static java.lang.String TYPE_DATETIME
          Parameter definition type constant.
static java.lang.String TYPE_EXTENSION_ID
          Parameter definition type constant.
static java.lang.String TYPE_EXTENSION_POINT_ID
          Parameter definition type constant.
static java.lang.String TYPE_FIXED
          Parameter definition type constant.
static java.lang.String TYPE_NULL
          Parameter definition type constant.
static java.lang.String TYPE_NUMBER
          Parameter definition type constant.
static java.lang.String TYPE_PLUGIN_ID
          Parameter definition type constant.
static java.lang.String TYPE_RESOURCE
          Parameter definition type constant.
static java.lang.String TYPE_STRING
          Parameter definition type constant.
static java.lang.String TYPE_TIME
          Parameter definition type constant.
 
Method Summary
 java.lang.String getCustomData()
           
 ExtensionPoint getDeclaringExtensionPoint()
           
 java.lang.String getMultiplicity()
           
 ExtensionPoint.ParameterDefinition getSubDefinition(java.lang.String id)
           
 java.util.Collection getSubDefinitions()
          Returns collection of all parameter sub-definitions declared in this parameter definition.
 ExtensionPoint.ParameterDefinition getSuperDefinition()
           
 java.lang.String getType()
           
 
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

TYPE_STRING

public static final java.lang.String TYPE_STRING
Parameter definition type constant.

See Also:
Constant Field Values

TYPE_BOOLEAN

public static final java.lang.String TYPE_BOOLEAN
Parameter definition type constant.

See Also:
Constant Field Values

TYPE_NUMBER

public static final java.lang.String TYPE_NUMBER
Parameter definition type constant.

See Also:
Constant Field Values

TYPE_DATE

public static final java.lang.String TYPE_DATE
Parameter definition type constant.

See Also:
Constant Field Values

TYPE_TIME

public static final java.lang.String TYPE_TIME
Parameter definition type constant.

See Also:
Constant Field Values

TYPE_DATETIME

public static final java.lang.String TYPE_DATETIME
Parameter definition type constant.

See Also:
Constant Field Values

TYPE_NULL

public static final java.lang.String TYPE_NULL
Parameter definition type constant.

See Also:
Constant Field Values

TYPE_ANY

public static final java.lang.String TYPE_ANY
Parameter definition type constant.

See Also:
Constant Field Values

TYPE_PLUGIN_ID

public static final java.lang.String TYPE_PLUGIN_ID
Parameter definition type constant.

See Also:
Constant Field Values

TYPE_EXTENSION_POINT_ID

public static final java.lang.String TYPE_EXTENSION_POINT_ID
Parameter definition type constant.

See Also:
Constant Field Values

TYPE_EXTENSION_ID

public static final java.lang.String TYPE_EXTENSION_ID
Parameter definition type constant.

See Also:
Constant Field Values

TYPE_FIXED

public static final java.lang.String TYPE_FIXED
Parameter definition type constant.

See Also:
Constant Field Values

TYPE_RESOURCE

public static final java.lang.String TYPE_RESOURCE
Parameter definition type constant.

See Also:
Constant Field Values

MULT_ONE

public static final java.lang.String MULT_ONE
Parameter definition multiplicity constant.

See Also:
Constant Field Values

MULT_ANY

public static final java.lang.String MULT_ANY
Parameter definition multiplicity constant.

See Also:
Constant Field Values

MULT_NONE_OR_ONE

public static final java.lang.String MULT_NONE_OR_ONE
Parameter definition multiplicity constant.

See Also:
Constant Field Values

MULT_ONE_OR_MORE

public static final java.lang.String MULT_ONE_OR_MORE
Parameter definition multiplicity constant.

See Also:
Constant Field Values
Method Detail

getMultiplicity

public java.lang.String getMultiplicity()
Returns:
multiplicity of parameter, that can be defined according to this definition

getType

public java.lang.String getType()
Returns:
value type of parameter, that can be defined according to this definition

getCustomData

public java.lang.String getCustomData()
Returns:
custom data for additional customization of some types

getSubDefinitions

public java.util.Collection getSubDefinitions()
Returns collection of all parameter sub-definitions declared in this parameter definition.

Returns:
collection of ExtensionPoint.ParameterDefinition objects

getSubDefinition

public 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

public ExtensionPoint getDeclaringExtensionPoint()
Returns:
extension point, this definition belongs to

getSuperDefinition

public ExtensionPoint.ParameterDefinition getSuperDefinition()
Returns:
parameter definition, of which this one is child or null if this is top level parameter definition

JPF 0.10

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