Package com.deltaxml.core.config

Enum Class CancellationPolicy

java.lang.Object

java.lang.Enum<CancellationPolicy>

com.deltaxml.core.config.CancellationPolicy

All Implemented Interfaces:

Serializable, Comparable<CancellationPolicy>, Constable

public enum CancellationPolicy
extends Enum<CancellationPolicy>

Determines whether and how the Comparator can be cancelled if it is taking too long.

• Timed The comparison will time out after the supplied interval.
• Interruptible The comparison will be cancelled when the Thread that is running it is interrupted.
• Cancel The comparison will be cancelled when the Comparator cancel method is called.
• Noop The comparison cannot be cancelled. This is the default.

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
Cancel	The comparison will be cancelled when the Comparator cancel method is called.
Interruptible	The comparison will be cancelled when the Thread that is running it is interrupted.
Noop	The comparison cannot be cancelled.
Timed	The comparison will time out after the supplied interval.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

Timed

public static final CancellationPolicy Timed

The comparison will time out after the supplied interval.

Interruptible

public static final CancellationPolicy Interruptible

The comparison will be cancelled when the Thread that is running it is interrupted.

Cancel

public static final CancellationPolicy Cancel

The comparison will be cancelled when the Comparator cancel method is called.

Noop

public static final CancellationPolicy Noop

The comparison cannot be cancelled. This is the default.

Method Details

values

public static CancellationPolicy[] 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 CancellationPolicy 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