Package jakarta.faces.application

Enum ViewVisitOption

java.lang.Object

java.lang.Enum<ViewVisitOption>

jakarta.faces.application.ViewVisitOption

All Implemented Interfaces:

Serializable, Comparable<ViewVisitOption>, java.lang.constant.Constable

public enum ViewVisitOption
extends Enum<ViewVisitOption>

Defines the view traversal options.

Since:

2.3

See Also:

• ViewHandler.getViews(jakarta.faces.context.FacesContext, String, int, ViewVisitOption...)
• ViewDeclarationLanguage.getViews(jakarta.faces.context.FacesContext, String, int, ViewVisitOption...)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
RETURN_AS_MINIMAL_IMPLICIT_OUTCOME	Return the logical views in the most minimal form form such that they can still be used for an implicit match by the navigation handler as described in the Jakarta Faces Specification Document section 7.4.2 "Default NavigationHandler Algorithm".

Method Summary

Modifier and Type	Method	Description
static ViewVisitOption	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ViewVisitOption[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

RETURN_AS_MINIMAL_IMPLICIT_OUTCOME

public static final ViewVisitOption RETURN_AS_MINIMAL_IMPLICIT_OUTCOME

Return the logical views in the most minimal form form such that they can still be used for an implicit match by the navigation handler as described in the Jakarta Faces Specification Document section 7.4.2 "Default NavigationHandler Algorithm".

For example, for the Facelets VDL a view such as /foo/bar.xhtml would be returned as /foo/bar.

Method Details

values

public static ViewVisitOption[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ViewVisitOption valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null