Top Description Methods
jakarta.faces.flow

public @Interface FlowScoped

extends Annotation
Annotations
@NormalScope
passivating:true
@Inherited
@Documented
@Target:TYPE
@Retention:RUNTIME
Imports
java.lang.annotation.Documented, .ElementType, .Inherited, .Retention, .RetentionPolicy, .Target, jakarta.enterprise.context.NormalScope

FlowScoped is a CDI scope that causes the runtime to consider classes with this annotation to be in the scope of the specified Flow. The implementation must provide an implementation of jakarta.enterprise.inject.spi.Extension that implements the semantics such that beans with this annotation are created lazily, when referenced, after the user enters into the specified Flow, and made available for garbage collection when the user exits the specified Flow. See FlowHandler#transition for the specification of flow entry and exit.

When replacing (rather than decorating) the flow implementation with a custom FlowHandler implementation, it is necessary to also replace the CDI extension that implements the specified behavior regarding FlowScoped beans.

Since
2.2

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the defining document id of this flow
definingDocumentId
()

If not empty, declare the defining document id within which the Flow referenced by value is unique.

public String

Returns:

the id of this flow
value
()

Must be equivalent to the Flow#getId of a defined flow for this application.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

definingDocumentIdback to summary
public String definingDocumentId()

If not empty, declare the defining document id within which the Flow referenced by value is unique. If empty the, the runtime assumes that all flow ids are unique within the scope of the application.

Returns:String

the defining document id of this flow

Since
2.2
valueback to summary
public String value()

Must be equivalent to the Flow#getId of a defined flow for this application.

Returns:String

the id of this flow

Since
2.2