org.ocpsoft.rewrite.context

Enum RewriteState

java.lang.Object

java.lang.Enum<RewriteState>

org.ocpsoft.rewrite.context.RewriteState

All Implemented Interfaces:

Serializable, Comparable<RewriteState>

public enum RewriteState
extends Enum<RewriteState>

Represents the the current Rewrite state during Rule execution.

Author:

Lincoln Baxter, III

Enum Constant Summary

Enum Constants

Enum Constant and Description
EVALUATING The system is currently evaluating configured Condition instances.
PERFORMING The system is currently performing configured Operation instances.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isEvaluating() Return true if this instance is equal to EVALUATING.
boolean	isPerforming() Return true if this instance is equal to PERFORMING.
static RewriteState	valueOf(String name) Returns the enum constant of this type with the specified name.
static RewriteState[]	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

EVALUATING

public static final RewriteState EVALUATING

The system is currently evaluating configured Condition instances.

PERFORMING

public static final RewriteState PERFORMING

The system is currently performing configured Operation instances.

Method Detail

values

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

Returns:

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

valueOf

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

isEvaluating

public boolean isEvaluating()

Return true if this instance is equal to EVALUATING.

isPerforming

public boolean isPerforming()

Return true if this instance is equal to PERFORMING.