LoopTool.Action (VelocityTools 2.0 Documentation)

Skip navigation links

All Classes

Summary:
Nested |
Enum Constants |
Field |
Method

Detail:
Enum Constants |
Field |
Method

java.lang.Object
- java.lang.Enum<LoopTool.Action>
- - org.apache.velocity.tools.generic.LoopTool.Action

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<LoopTool.Action>

Enclosing class:

LoopTool
```
public static enum LoopTool.Action
extends java.lang.Enum<LoopTool.Action>
```
Represents an automatic action taken by a LoopTool.ManagedIterator when a LoopTool.Condition is satisfied by the subsequent element.

Enum Constant Summary

Enum Constants
Enum Constant and Description

EXCLUDE

STOP

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static LoopTool.Action`	`valueOf(java.lang.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(java.lang.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:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null

Skip navigation links

All Classes

Summary:
Nested |
Enum Constants |
Field |
Method

Detail:
Enum Constants |
Field |
Method

Copyright (c) 2003-2007 Apache Software Foundation