Module org.omnifaces

Package org.omnifaces.facesviews

Enum ExtensionAction

java.lang.Object

java.lang.Enum<ExtensionAction>

org.omnifaces.facesviews.ExtensionAction

All Implemented Interfaces:

Serializable, Comparable<ExtensionAction>

public enum ExtensionAction
extends Enum<ExtensionAction>

The action that is done when a Faces Views request with an extension is done.

Note that this is only used for views that were discovered via Faces Views. It has no affect on other resources, even if they have the same extension.

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

Since:

1.4

Author:

Arjan Tijms

See Also:

FacesViews, FacesViewsForwardingFilter

Enum Constant Summary

Enum Constants

Enum Constant	Description
PROCEED	No special action is taken.
REDIRECT_TO_EXTENSIONLESS	Redirects to the same URL, but with the extension removed.
SEND_404	Send a 404 (not found), makes it look like e.g.

Method Summary

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

REDIRECT_TO_EXTENSIONLESS

public static final ExtensionAction REDIRECT_TO_EXTENSIONLESS

Redirects to the same URL, but with the extension removed. E.g. "/foo.xhtml" is redirected to "/foo".

This is the default value.

SEND_404

public static final ExtensionAction SEND_404

Send a 404 (not found), makes it look like e.g. "foo.xhtml" never existed and there's only "foo".

PROCEED

public static final ExtensionAction PROCEED

No special action is taken. Both "/foo.xhtml" and "/foo" are processed as-if they were separate views (with same content).

Method Detail

values

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

Returns:

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

valueOf

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