net.sf.jett.model.PastEndAction Maven / Gradle / Ivy

package net.sf.jett.model;

/**
 * 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
 */
public enum PastEndAction
{
    /**
     * 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.
     */
    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 removed, formatting and all.
     */
    REMOVE_CELL,
    /**
     * 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
     */
    REPLACE_EXPR
}