org.apache.tapestry.annotations
Annotation Type Parameter

@Target(value=METHOD)
@Retention(value=RUNTIME)
@Documented
public @interface Parameter

Used to define a parameter for the component.

Since:

4.0

Author:

Howard Lewis Ship

Optional Element Summary

String	aliases An optional list of alternate names for the parameter.
boolean	cache If true (the default), then the binding will cache its value while the component is renderering.
String	defaultValue The default value for the binding, as a binding reference.
String	name The name of the parameter.
boolean	required If true, then the parameter is required, and must be bound (there is no guarantee that a non-null value will be bound however, so the component may have to perform additonal checks).

required

public abstract boolean required

If true, then the parameter is required, and must be bound (there is no guarantee that a non-null value will be bound however, so the component may have to perform additonal checks). The default value, false, means the parameter is optional.

Default:

false

defaultValue

public abstract String defaultValue

The default value for the binding, as a binding reference.

Default:

""

cache

public abstract boolean cache

If true (the default), then the binding will cache its value while the component is renderering. In some cases, it is desirable to force the binding to be re-evaluated every time the parameter property is accessed, in which case cache should be set to false.

Default:

true

aliases

public abstract String aliases

An optional list of alternate names for the parameter. The parameter may be bound using its true name or any alias (but not both!), but use of aliases will generate deprecation warnings.

Default:

""

name

public abstract String name

The name of the parameter. If not specified, it will match the property name. Note that this is backwards from the logic in the XML, where the parameter name is specified and the property name matches.

Default:

""