public class AnnotationParameterDescriptor extends Object implements ParameterDescriptor
ParameterDescriptor
implementation for the
Parameter
annotation.Constructor and Description |
---|
AnnotationParameterDescriptor(String name,
Class<?> dataType,
boolean isDeprecated,
Parameter annotation) |
Modifier and Type | Method and Description |
---|---|
String |
getAlias() |
Parameter |
getAnnotation() |
String |
getCondition()
Gets a conditional expression which must return
true in order to indicate
that the parameter value is valid, e.g. |
Class<? extends Converter> |
getConverterClass()
A converter to be used to convert a text to the parameter value and vice versa.
|
Class<?> |
getDataType() |
String |
getDefaultValue()
Gets the parameter's default value.
|
String |
getDescription() |
Class<? extends DomConverter> |
getDomConverterClass()
A converter to be used to convert an (XML) DOM to the parameter value and vice versa.
|
String |
getFormat()
Gets a format string to which a textual parameter value must match in order to indicate
a valid value, e.g.
|
String |
getInterval()
Gets the valid interval for numeric parameters, e.g.
|
String |
getItemAlias() |
String |
getLabel() |
String |
getName() |
String |
getPattern()
Gets a regular expression pattern to which a textual parameter value must match in order to indicate
a valid value, e.g.
|
Class<? extends RasterDataNode> |
getRasterDataNodeClass()
Specifies which
RasterDataNode subclass of the source products is used
to fill the ParameterDescriptor.getValueSet() for this parameter. |
ParameterDescriptor[] |
getStructureMemberDescriptors() |
String |
getUnit() |
Class<? extends Validator> |
getValidatorClass()
A validator to be used to validate a parameter value.
|
String[] |
getValueSet()
Gets the set of values which can be assigned to a parameter field.
|
boolean |
isDeprecated()
Is the parameter marked as deprecated?
|
boolean |
isNotEmpty()
Parameter value must not be an empty string?
|
boolean |
isNotNull()
Parameter value must not be
null ? |
boolean |
isStructure() |
public String getName()
getName
in interface ElementDescriptor
public Class<?> getDataType()
getDataType
in interface DataElementDescriptor
Object
.public Parameter getAnnotation()
public String getAlias()
getAlias
in interface ElementDescriptor
null
if not declared.public String getItemAlias()
getItemAlias
in interface ParameterDescriptor
public String getDefaultValue()
ParameterDescriptor
Converter
.getDefaultValue
in interface ParameterDescriptor
ParameterDescriptor.getConverterClass()
public String getLabel()
getLabel
in interface ElementDescriptor
null
if not declared.public String getUnit()
getUnit
in interface ParameterDescriptor
public String getDescription()
getDescription
in interface ElementDescriptor
null
if not declared.public String[] getValueSet()
ParameterDescriptor
Converter
.getValueSet
in interface ParameterDescriptor
ParameterDescriptor.getConverterClass()
public String getInterval()
ParameterDescriptor
"[10,20)"
: in the range 10 (inclusive) to 20 (exclusive).getInterval
in interface ParameterDescriptor
public String getCondition()
ParameterDescriptor
true
in order to indicate
that the parameter value is valid, e.g. "value > 2.5"
.getCondition
in interface ParameterDescriptor
public String getPattern()
ParameterDescriptor
"a*"
.getPattern
in interface ParameterDescriptor
Pattern
public String getFormat()
ParameterDescriptor
"yyyy-MM-dd HH:mm:ss.Z"
.getFormat
in interface ParameterDescriptor
Format
public boolean isNotNull()
ParameterDescriptor
null
?isNotNull
in interface ParameterDescriptor
true
, if so. Defaults to false
.public boolean isNotEmpty()
ParameterDescriptor
isNotEmpty
in interface ParameterDescriptor
true
, if so. Defaults to false
.public boolean isDeprecated()
ParameterDescriptor
isDeprecated
in interface ParameterDescriptor
true
, if so. Defaults to false
.public Class<? extends Validator> getValidatorClass()
ParameterDescriptor
getValidatorClass
in interface ParameterDescriptor
public Class<? extends Converter> getConverterClass()
ParameterDescriptor
getConverterClass
in interface ParameterDescriptor
public Class<? extends DomConverter> getDomConverterClass()
ParameterDescriptor
getDomConverterClass
in interface ParameterDescriptor
public Class<? extends RasterDataNode> getRasterDataNodeClass()
ParameterDescriptor
RasterDataNode
subclass of the source products is used
to fill the ParameterDescriptor.getValueSet()
for this parameter.getRasterDataNodeClass
in interface ParameterDescriptor
public boolean isStructure()
isStructure
in interface ParameterDescriptor
true
if the parameter type is a composite data structure.DataElementDescriptor.getDataType()
,
ParameterDescriptor.getStructureMemberDescriptors()
public ParameterDescriptor[] getStructureMemberDescriptors()
getStructureMemberDescriptors
in interface ParameterDescriptor
DataElementDescriptor.getDataType()
,
ParameterDescriptor.isStructure()
Copyright © 2014–2015 European Space Agency (ESA). All rights reserved.