public class ParameterDefinition extends DefinitionBase
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
KEY_ENTRIES
parameter property: list of entries of map parameters.
|
static java.lang.String |
KEY_MULTI
parameter property: multiple values allowed?
|
static java.lang.String |
KEY_OPTIONAL
property for optional parameters.
|
static java.lang.String |
KEY_RANGE
parameter property: range.
|
static java.lang.String |
KEY_TYPE
property for type of parameters.
|
static java.lang.String |
KEY_VALUE
parameter property: list of accepted values.
|
static java.lang.String |
KEY_VALUES
parameter property: list of accepted values.
|
protected static java.util.Collection<java.lang.String> |
MAIN_PARAMETER_KEYS
parameter property keys to keep when creating a description without details.
|
static java.lang.String |
TYPENAME_ANY
external name of type "any".
|
static java.lang.String |
VARIABLE_NAME_EXPRESSION
the expression denoting a variable parameter name.
|
_definitionMap, _name, _readOnly, _timestamp, KEY_NAME, KEY_READ_ONLY, KEY_TIMESTAMP| Constructor and Description |
|---|
ParameterDefinition(AnyMap definitionAny)
constructor to parse a definition from an Any.
|
| Modifier and Type | Method and Description |
|---|---|
java.util.List<ParameterDefinition> |
getEntries()
list of allowed entries for map parameters, null if not defined or for other types.
|
java.lang.String |
getRange()
returns the range of this parameter.
|
Any.ValueType |
getType() |
java.lang.String |
getTypeName() |
java.util.List<Value> |
getValues()
list of allowed values, null if not defined or for map/any types.
|
boolean |
isMulti()
is it allowed for this parameter to have multiple values?
|
boolean |
isOptional()
is this an optional parameter?
|
static java.util.List<ParameterDefinition> |
parseParameters(AnySeq parameterSequence)
parse parameter defintion from a AnySeq.
|
AnyMap |
toAny(boolean includingAdditionalAttributes)
Returns object information as an Any representation.
|
static AnySeq |
toAny(java.util.List<ParameterDefinition> parameters,
boolean includingAdditionalAttributes) |
protected boolean |
validateName()
disable name validation.
|
getName, getTimestamp, isReadOnly, toAny, toStringpublic static final java.lang.String TYPENAME_ANY
public static final java.lang.String KEY_TYPE
public static final java.lang.String KEY_OPTIONAL
public static final java.lang.String KEY_VALUES
public static final java.lang.String KEY_VALUE
public static final java.lang.String KEY_MULTI
public static final java.lang.String KEY_ENTRIES
public static final java.lang.String KEY_RANGE
public static final java.lang.String VARIABLE_NAME_EXPRESSION
protected static final java.util.Collection<java.lang.String> MAIN_PARAMETER_KEYS
public ParameterDefinition(AnyMap definitionAny) throws InvalidDefinitionException
InvalidDefinitionExceptionprotected boolean validateName()
validateName in class DefinitionBasepublic static AnySeq toAny(java.util.List<ParameterDefinition> parameters, boolean includingAdditionalAttributes)
parameters - parameters with additional attributes.MAIN_PARAMETER_KEYS and
the parameters in KEY_ENTRIES "withoutAdditionalInformation", will be set for each parameter.public AnyMap toAny(boolean includingAdditionalAttributes)
toAny in class DefinitionBaseincludingAdditionalAttributes - 'true' if also any additional information in the AnyMap should be returned, 'false' if only the (minimal
set of) relevant information should be returned.public static java.util.List<ParameterDefinition> parseParameters(AnySeq parameterSequence) throws InvalidDefinitionException
InvalidDefinitionExceptionpublic Any.ValueType getType()
public java.lang.String getTypeName()
Enum.name() (in lower case), or TYPENAME_ANY, if type
is null.public boolean isOptional()
public boolean isMulti()
public java.util.List<Value> getValues()
public java.util.List<ParameterDefinition> getEntries()
public java.lang.String getRange()