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

java.lang.Object
  extended by java.lang.Enum<LoopTool.Action>
      extended by org.apache.velocity.tools.generic.LoopTool.Action
All Implemented Interfaces:
Serializable, Comparable<LoopTool.Action>
Enclosing class:
LoopTool

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

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


Enum Constant Summary
EXCLUDE
           
STOP
           
 
Method Summary
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 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

EXCLUDE

public static final LoopTool.Action EXCLUDE

STOP

public static final LoopTool.Action STOP
Method Detail

values

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

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


Copyright © 2002-2011 The Apache Software Foundation. All Rights Reserved.