Package net.sf.jett.model

Enum PastEndAction

java.lang.Object

java.lang.Enum<PastEndAction>

net.sf.jett.model.PastEndAction

public enum PastEndAction
extends java.lang.Enum<PastEndAction>

A PastEndAction enumerated value specifies a possible action when dealing with expressions that reference collection items beyond the end of the iteration. This comes up when a MultiForEachTag is operating on collections of different sizes, and one collection has run out of values before another collection.

If such an expression were written in Java code, it would result in an IndexOutOfBoundsException. Each enumerated value specifies a way of handling this condition.

Author:

Randy Gettman

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLEAR_CELL	Specifies that any Cell containing an expression that references a collection item beyond the end of the iteration should result in the entire Cell being blanked out.
REMOVE_CELL	Specifies that any Cell containing an expression that references a collection item beyond the end of the iteration should result in the entire Cell being removed, formatting and all.
REPLACE_EXPR	Specifies that any Cell containing an expression that references a collection item beyond the end of the collection should result only in those expressions containing a reference to the collection item being replaced, e.g.

Method Summary

Modifier and Type	Method	Description
static PastEndAction	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static PastEndAction[]	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

CLEAR_CELL

public static final PastEndAction CLEAR_CELL

Specifies that any Cell containing an expression that references a collection item beyond the end of the iteration should result in the entire Cell being blanked out.

REMOVE_CELL

public static final PastEndAction REMOVE_CELL

Specifies that any Cell containing an expression that references a collection item beyond the end of the iteration should result in the entire Cell being removed, formatting and all.

REPLACE_EXPR

public static final PastEndAction REPLACE_EXPR

Specifies that any Cell containing an expression that references a collection item beyond the end of the collection should result only in those expressions containing a reference to the collection item being replaced, e.g. ${notBeyondCollection} and ${beyondCollection} becomes NotBeyondValue and, or NotBeyondValue and -, depending on whether a specific replacement value is given.

Since:

0.7.0

Method Detail

values

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

Returns:

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

valueOf

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