org.ocpsoft.rewrite.servlet.event

Enum BaseRewrite.Flow

java.lang.Object

java.lang.Enum<BaseRewrite.Flow>

org.ocpsoft.rewrite.servlet.event.BaseRewrite.Flow

All Implemented Interfaces:

Serializable, Comparable<BaseRewrite.Flow>

Enclosing class:

BaseRewrite<IN extends javax.servlet.ServletRequest,OUT extends javax.servlet.ServletResponse>

public static enum BaseRewrite.Flow
extends Enum<BaseRewrite.Flow>

Enum to represent the finite state of the Rewrite container.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABORT_REQUEST
CONTINUE
FORWARD
HANDLED
INCLUDE
PROCEED
REDIRECT_PERMANENT
REDIRECT_TEMPORARY
UN_HANDLED

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(BaseRewrite.Flow other) Return true if the given BaseRewrite.Flow is a descendant of this.
boolean	is(BaseRewrite.Flow other) Return true if this BaseRewrite.Flow is a descendant of the given value.
static BaseRewrite.Flow	valueOf(String name) Returns the enum constant of this type with the specified name.
static BaseRewrite.Flow[]	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

UN_HANDLED

public static final BaseRewrite.Flow UN_HANDLED

HANDLED

public static final BaseRewrite.Flow HANDLED

PROCEED

public static final BaseRewrite.Flow PROCEED

CONTINUE

public static final BaseRewrite.Flow CONTINUE

INCLUDE

public static final BaseRewrite.Flow INCLUDE

ABORT_REQUEST

public static final BaseRewrite.Flow ABORT_REQUEST

FORWARD

public static final BaseRewrite.Flow FORWARD

REDIRECT_TEMPORARY

public static final BaseRewrite.Flow REDIRECT_TEMPORARY

REDIRECT_PERMANENT

public static final BaseRewrite.Flow REDIRECT_PERMANENT

Method Detail

values

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

Returns:

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

valueOf

public static BaseRewrite.Flow 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

is

public boolean is(BaseRewrite.Flow other)

Return true if this BaseRewrite.Flow is a descendant of the given value.

contains

public boolean contains(BaseRewrite.Flow other)

Return true if the given BaseRewrite.Flow is a descendant of this.