Module org.omnifaces

Package org.omnifaces.facesviews

Enum PathAction

java.lang.Object

java.lang.Enum<PathAction>

org.omnifaces.facesviews.PathAction

All Implemented Interfaces:

Serializable, Comparable<PathAction>

public enum PathAction
extends Enum<PathAction>

The action that is done when a request for a public path from which faces views where scanned is done.

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

Since:

1.4

Author:

Arjan Tijms

See Also:

FacesViewsForwardingFilter

Enum Constant Summary

Enum Constants

Enum Constant	Description
PROCEED	No special action is taken.
REDIRECT_TO_SCANNED_EXTENSIONLESS	Redirects to the resource corresponding with the one that was scanned. e.g.
SEND_404	Send a 404 (not found), makes it look like e.g.

Method Summary

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

SEND_404

public static final PathAction SEND_404

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

This is the default value.

REDIRECT_TO_SCANNED_EXTENSIONLESS

public static final PathAction REDIRECT_TO_SCANNED_EXTENSIONLESS

Redirects to the resource corresponding with the one that was scanned. e.g. "/path/foo.xml" redirects to "/foo".

PROCEED

public static final PathAction PROCEED

No special action is taken. "/path/foo.xml" and "/foo" (and potentially "/foo.xhtml") will be accessible.

Method Detail

values

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

Returns:

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

valueOf

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