org.apache.beehive.netui.pageflow.annotations
Annotation Type Jpf.ActionOutput

@Target(value=ANNOTATION_TYPE)
@Retention(value=RUNTIME)
public static @interface Jpf.ActionOutput

An action output, which is declared in a @Jpf.Forward annotation and passed from an action method on a Forward object. An action output may be used as a "page input" in a page, where it is accessed by databinding to ${pageInput.action-output-name}. The benefit of action outputs (over setting request attributes) is that the annotations are visible to tools, and that there is runtime checking of type and required-presence.

name

public abstract String name

The name of the action output. This is the action-output-name in the databinding expression ${pageInput.action-output-name}.

type

public abstract Class type

The type of the action output. This will be checked by the runtime if the server is not in production mode, and if the type check fails, a MismatchedActionOutputException will be thrown.

typeHint

public abstract String typeHint

A String version of the type information that can be used by tools or as runtime-accessable information, particularly to add generics to the type (generics are "erased" during compilation and are not available to the runtime through reflection).

Default:

""

required

public abstract boolean required

If true, a MissingActionOutputException will be thrown when the associated Forward object does not include a value for this named action output.

Default:

true