com.deltaxml.cores9api.config

Enum CancellationPolicy

java.lang.Object

java.lang.Enum<CancellationPolicy>

com.deltaxml.cores9api.config.CancellationPolicy

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CancellationPolicy>

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

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

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

Enum Constant Summary

Enum Constants

Enum Constant and 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 and Description
static CancellationPolicy	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CancellationPolicy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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 Detail

values

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

Returns:

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

valueOf

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