jakarta.faces.application

Enum ResourceVisitOption

java.lang.Object

java.lang.Enum<ResourceVisitOption>

jakarta.faces.application.ResourceVisitOption

All Implemented Interfaces:

Serializable, Comparable<ResourceVisitOption>

public enum ResourceVisitOption
extends Enum<ResourceVisitOption>

Defines the resource traversal options.

Since:

2.3

See Also:

ResourceHandler.getViewResources(jakarta.faces.context.FacesContext, String, int, ResourceVisitOption...)

Enum Constant Summary

Enum Constants

Enum Constant and Description
TOP_LEVEL_VIEWS_ONLY Only visit resources that are top level views, i.e.

Method Summary

Modifier and Type	Method and Description
static ResourceVisitOption	valueOf(String name) Returns the enum constant of this type with the specified name.
static ResourceVisitOption[]	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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TOP_LEVEL_VIEWS_ONLY

public static final ResourceVisitOption TOP_LEVEL_VIEWS_ONLY

Only visit resources that are top level views, i.e. views that can be used to serve a request as opposed to those that can only be used for includes.

Method Detail

values

public static ResourceVisitOption[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ResourceVisitOption c : ResourceVisitOption.values())
    System.out.println(c);

Returns:

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

valueOf

public static ResourceVisitOption 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