Enum LoopTool.Action

java.lang.Object

java.lang.Enum<LoopTool.Action>

org.apache.velocity.tools.generic.LoopTool.Action

All Implemented Interfaces:

Serializable, Comparable<LoopTool.Action>, java.lang.constant.Constable

Enclosing class:

LoopTool

public static enum LoopTool.Action
extends Enum<LoopTool.Action>

Represents an automatic action taken by a LoopTool.ManagedIterator when a LoopTool.Condition is satisfied by the subsequent element.

Version:

$Id: LoopTool.java 590893 2007-11-01 04:40:21Z nbubna $

Author:

Nathan Bubna

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EXCLUDE
STOP

Method Summary

Modifier and Type	Method	Description
static LoopTool.Action	valueOf(String name)	Returns the enum constant of this type with the specified name.
static LoopTool.Action[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

EXCLUDE

public static final LoopTool.Action EXCLUDE

STOP

public static final LoopTool.Action STOP

Method Details

values

public static LoopTool.Action[] values()

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

Returns:

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

valueOf

public static LoopTool.Action 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