public interface IParameterSpecification extends org.apache.hivemind.LocationHolder
IParameterSpecification
is contained
by a IComponentSpecification
.
TBD: Identify arrays in some way.
Modifier and Type | Method and Description |
---|---|
java.util.Collection |
getAliasNames()
Returns a non-null collection of strings for the aliases of the parameter.
|
boolean |
getCache()
Returns true if the parameter property should cache the result of the binding.
|
java.lang.String |
getDefaultValue()
Returns the default value for the parameter (or null if the parameter has no default value).
|
java.lang.String |
getDescription()
Returns the documentation for this parameter.
|
java.lang.String |
getParameterName()
Returns the (primary) name of the parameter.
|
java.lang.String |
getPropertyName()
Returns the name of the JavaBeans property to connect the parameter to.
|
java.lang.String |
getType()
Returns the class name of the expected type of the parameter.
|
boolean |
isDeprecated()
Returns true if the parameter is deprecated.
|
boolean |
isRequired()
Returns true if the parameter is required by the component.
|
void |
setAliases(java.lang.String nameList)
Sets the list of aliases as a comma-seperated list.
|
void |
setCache(boolean cache) |
void |
setDefaultValue(java.lang.String defaultValue)
Sets the default value of the JavaBeans property if no binding is provided
|
void |
setDeprecated(boolean deprecated) |
void |
setDescription(java.lang.String description)
Sets the documentation for this parameter.
|
void |
setParameterName(java.lang.String name) |
void |
setPropertyName(java.lang.String propertyName)
Sets the property name (of the component class) to connect the parameter to.
|
void |
setRequired(boolean value) |
void |
setType(java.lang.String value)
Sets the type of value expected for the parameter.
|
java.lang.String getType()
java.lang.Object
which matches anything.boolean isRequired()
void setRequired(boolean value)
void setType(java.lang.String value)
java.lang.String getDescription()
void setDescription(java.lang.String description)
void setPropertyName(java.lang.String propertyName)
java.lang.String getPropertyName()
java.lang.String getDefaultValue()
void setDefaultValue(java.lang.String defaultValue)
boolean getCache()
void setCache(boolean cache)
java.lang.String getParameterName()
void setParameterName(java.lang.String name)
java.util.Collection getAliasNames()
void setAliases(java.lang.String nameList)
nameList
- a comma seperated list of names, which may be null or emptyboolean isDeprecated()
void setDeprecated(boolean deprecated)