Package nz.org.riskscape.engine.pipeline

Enum Class Collector.Characteristic

java.lang.Object

java.lang.Enum<Collector.Characteristic>

nz.org.riskscape.engine.pipeline.Collector.Characteristic

All Implemented Interfaces:

Serializable, Comparable<Collector.Characteristic>, Constable

Enclosing interface:

Collector<T>

public static enum Collector.Characteristic
extends Enum<Collector.Characteristic>

A set of characteristics a collector can have which allow the PipelineExecutor to better optimise and organize execution.

Currently only PARALLELIZABLE exists, but others might be added, such as whether accumulators share state (so there will be some level of locking).

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
PARALLELIZABLE	The collector can be parallelized by creating multiple accumulators and combining them before processing.

Method Summary

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

PARALLELIZABLE

public static final Collector.Characteristic PARALLELIZABLE

The collector can be parallelized by creating multiple accumulators and combining them before processing.

Method Details

values

public static Collector.Characteristic[] 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 Collector.Characteristic 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