org.omnifaces.facesviews

Enum ViewHandlerMode

java.lang.Object

java.lang.Enum<ViewHandlerMode>

org.omnifaces.facesviews.ViewHandlerMode

All Implemented Interfaces:

Serializable, Comparable<ViewHandlerMode>

public enum ViewHandlerMode
extends Enum<ViewHandlerMode>

The mode of the view handler with respect to constructing an action URL.

For a guide on FacesViews, please see the package summary.

Since:

1.5

Author:

Arjan Tijms

See Also:

FacesViews, FacesViewsViewHandler

Enum Constant Summary

Enum Constants

Enum Constant and Description
BUILD_WITH_PARENT_QUERY_PARAMETERS The FacesViewsViewHandler constructs the action URL itself, but takes the query parameters (if any) from the outcome of the parent view handler.
STRIP_EXTENSION_FROM_PARENT Takes the outcome from the parent view handler and strips the extension from it.

Method Summary

Modifier and Type	Method and Description
static ViewHandlerMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static ViewHandlerMode[]	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

STRIP_EXTENSION_FROM_PARENT

public static final ViewHandlerMode STRIP_EXTENSION_FROM_PARENT

Takes the outcome from the parent view handler and strips the extension from it.

This is the default value.

BUILD_WITH_PARENT_QUERY_PARAMETERS

public static final ViewHandlerMode BUILD_WITH_PARENT_QUERY_PARAMETERS

The FacesViewsViewHandler constructs the action URL itself, but takes the query parameters (if any) from the outcome of the parent view handler.

Method Detail

values

public static ViewHandlerMode[] 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 (ViewHandlerMode c : ViewHandlerMode.values())
    System.out.println(c);

Returns:

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

valueOf

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