com.uwyn.rife.engine.annotations
Annotation Type ParamProperty


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

Declares that the bean property that corresponds to the annotated setter will be used as a submission parameter. The name of the parameter will be the name of the property, and the parameter will be added to the previous submission that has been declared.

If no submission has been declared beforehand, either through Submission or SubmissionHandler, an exception will be thrown when the annotations of this element are evaluated.

When the element is processed, the value of the parameter will be injected into the element through the setter and RIFE's type conversion will try to convert the parameter's string value into the property type. A ParameterInjectionException exception will be thrown if the conversion failed.

Since:
1.5
Version:
$Revision: 3687 $
Author:
Geert Bevin (gbevin[remove] at uwyn dot com)
See Also:
Param, ParamRegexp, Submission, SubmissionHandler

Optional Element Summary
 String[] defaultValues
          The default values of the parameter.
 String name
          The expected name of the property.
 

name

public abstract String name
The expected name of the property.

This hasn't got any influence on the actual name that is being used for the property, but is used instead to ensure that the property name is the same as the one specified here. This is typically used to create a single point of declaration for the property name that can be referenced elsewhere and that is ensured to be correct.

Since:
1.6
Default:
""

defaultValues

public abstract String[] defaultValues
The default values of the parameter.

Since:
1.5
Default:
{}


Copyright © 2001-2007 Uwyn sprl/bvba. All Rights Reserved.