org.apache.tapestry.spec

Class ParameterSpecification

java.lang.Object

org.apache.hivemind.impl.BaseLocatable

org.apache.tapestry.spec.ParameterSpecification

All Implemented Interfaces:

org.apache.hivemind.Locatable, org.apache.hivemind.LocationHolder, IParameterSpecification

public class ParameterSpecification
extends org.apache.hivemind.impl.BaseLocatable
implements IParameterSpecification

Defines a formal parameter to a component. A IParameterSpecification is contained by a IComponentSpecification.

TBD: Identify arrays in some way.

Author:

Howard Lewis Ship

Constructor Summary

Constructors

Constructor and Description
ParameterSpecification()

Method Summary

Methods

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.

Methods inherited from class org.apache.hivemind.impl.BaseLocatable

getLocation, setLocation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.hivemind.LocationHolder

setLocation

Methods inherited from interface org.apache.hivemind.Locatable

getLocation

Constructor Detail

ParameterSpecification

public ParameterSpecification()

Method Detail

getType

public java.lang.String getType()

Returns the class name of the expected type of the parameter. The default value is java.lang.Object which matches anything.

Specified by:

getType in interface IParameterSpecification

isRequired

public boolean isRequired()

Returns true if the parameter is required by the component. The default is false, meaning the parameter is optional.

Specified by:

isRequired in interface IParameterSpecification

setRequired

public void setRequired(boolean value)

Specified by:

setRequired in interface IParameterSpecification

setType

public void setType(java.lang.String value)

Sets the type of value expected for the parameter. This can be left blank to indicate any type.

Specified by:

setType in interface IParameterSpecification

getDescription

public java.lang.String getDescription()

Returns the documentation for this parameter.

Specified by:

getDescription in interface IParameterSpecification

Since:

1.0.9

setDescription

public void setDescription(java.lang.String description)

Sets the documentation for this parameter.

Specified by:

setDescription in interface IParameterSpecification

Since:

1.0.9

setPropertyName

public void setPropertyName(java.lang.String propertyName)

Sets the property name (of the component class) to connect the parameter to.

Specified by:

setPropertyName in interface IParameterSpecification

getPropertyName

public java.lang.String getPropertyName()

Returns the name of the JavaBeans property to connect the parameter to.

Specified by:

getPropertyName in interface IParameterSpecification

getDefaultValue

public java.lang.String getDefaultValue()

Description copied from interface: IParameterSpecification

Returns the default value for the parameter (or null if the parameter has no default value). Required parameters may not have a default value. The default value is a binding locator (a prefixed value, as with a binding element).

Specified by:

getDefaultValue in interface IParameterSpecification

See Also:

IParameterSpecification.getDefaultValue()

setDefaultValue

public void setDefaultValue(java.lang.String defaultValue)

Description copied from interface: IParameterSpecification

Sets the default value of the JavaBeans property if no binding is provided

Specified by:

setDefaultValue in interface IParameterSpecification

See Also:

IParameterSpecification.setDefaultValue(java.lang.String)

getCache

public boolean getCache()

Description copied from interface: IParameterSpecification

Returns true if the parameter property should cache the result of the binding.

Specified by:

getCache in interface IParameterSpecification

Since:

4.0

setCache

public void setCache(boolean cache)

Specified by:

setCache in interface IParameterSpecification

Since:

4.0

getAliasNames

public java.util.Collection getAliasNames()

Description copied from interface: IParameterSpecification

Returns a non-null collection of strings for the aliases of the parameter. This is usually an empty list.

Specified by:

getAliasNames in interface IParameterSpecification

Since:

4.0

getParameterName

public java.lang.String getParameterName()

Description copied from interface: IParameterSpecification

Returns the (primary) name of the parameter.

Specified by:

getParameterName in interface IParameterSpecification

Since:

4.0

setAliases

public void setAliases(java.lang.String nameList)

Description copied from interface: IParameterSpecification

Sets the list of aliases as a comma-seperated list.

Specified by:

setAliases in interface IParameterSpecification

Parameters:

nameList - a comma seperated list of names, which may be null or empty

Since:

4.0

setParameterName

public void setParameterName(java.lang.String name)

Specified by:

setParameterName in interface IParameterSpecification

Since:

4.0

isDeprecated

public boolean isDeprecated()

Description copied from interface: IParameterSpecification

Returns true if the parameter is deprecated. Deprecated parameter generate a warning when bound.

Specified by:

isDeprecated in interface IParameterSpecification

Since:

4.0

setDeprecated

public void setDeprecated(boolean deprecated)

Specified by:

setDeprecated in interface IParameterSpecification

Since:

4.0