Package ch.tocco.nice2.persist.core.api.exec

Enum Class CollectMode

java.lang.Object

java.lang.Enum<CollectMode>

ch.tocco.nice2.persist.core.api.exec.CollectMode

All Implemented Interfaces:

Serializable, Comparable<CollectMode>, Constable

public enum CollectMode
extends Enum<CollectMode>

Used with persist tasks to determine whether results of loops are collected or not. This is used with all tasks that are created via combinators that return a collection.

See Also:

• Keys.COLLECTMODE

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	Collect all results from the loop body.
FIRST	Collect only the first result.
NONE	Do not collect any results.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final CollectMode NONE

Do not collect any results. Tasks always return an empty collection.

FIRST

public static final CollectMode FIRST

Collect only the first result. This can be useful to check whether there was a non-null result created in the loop body.

ALL

public static final CollectMode ALL

Collect all results from the loop body.

Method Details

values

public static CollectMode[] values()

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

Returns:

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

valueOf

public static CollectMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null