org.jboss.seam.annotations
Annotation Type Out


@Target(value={FIELD,METHOD})
@Retention(value=RUNTIME)
@Documented
public @interface Out

Specifies that a seam component should be outjected from the annotated field or getter method of a session bean.

Author:
Gavin King

Optional Element Summary
 boolean required
          Specifies that the outjected value must not be null, by default.
 ScopeType scope
          Specifies the scope to outject to.
 String value
          The context variable name.
 

value

public abstract String value
The context variable name. Defaults to the name of the annotated field or getter method.

Default:
""

required

public abstract boolean required
Specifies that the outjected value must not be null, by default.

Default:
true

scope

public abstract ScopeType scope
Specifies the scope to outject to. If no scope is explicitly specified, the default scope depends upon whether the value is an instance of a Seam component. If it is, the component scope is used. Otherwise, the scope of the component with the @Out attribute is used. But if the component scope is STATELESS, the EVENT scope is used.

Default:
org.jboss.seam.ScopeType.UNSPECIFIED


Copyright © 2011 Seam Framework. All Rights Reserved.