org.ocpsoft.rewrite.servlet.event

Enum BaseRewrite.ServletRewriteFlow

java.lang.Object

java.lang.Enum<BaseRewrite.ServletRewriteFlow>

org.ocpsoft.rewrite.servlet.event.BaseRewrite.ServletRewriteFlow

All Implemented Interfaces:

Serializable, Comparable<BaseRewrite.ServletRewriteFlow>, Flow

Enclosing class:

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

public static enum BaseRewrite.ServletRewriteFlow
extends Enum<BaseRewrite.ServletRewriteFlow>
implements 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

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

HANDLED

public static final BaseRewrite.ServletRewriteFlow HANDLED

PROCEED

public static final BaseRewrite.ServletRewriteFlow PROCEED

CONTINUE

public static final BaseRewrite.ServletRewriteFlow CONTINUE

INCLUDE

public static final BaseRewrite.ServletRewriteFlow INCLUDE

ABORT_REQUEST

public static final BaseRewrite.ServletRewriteFlow ABORT_REQUEST

FORWARD

public static final BaseRewrite.ServletRewriteFlow FORWARD

REDIRECT_TEMPORARY

public static final BaseRewrite.ServletRewriteFlow REDIRECT_TEMPORARY

REDIRECT_PERMANENT

public static final BaseRewrite.ServletRewriteFlow REDIRECT_PERMANENT

Method Detail

values

public static BaseRewrite.ServletRewriteFlow[] 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.ServletRewriteFlow c : BaseRewrite.ServletRewriteFlow.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.ServletRewriteFlow 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.ServletRewriteFlow other)

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

contains

public boolean contains(BaseRewrite.ServletRewriteFlow other)

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

isHandled

public boolean isHandled()

Specified by:

isHandled in interface Flow

is

public boolean is(Flow flow)

Specified by:

is in interface Flow