net.automatalib.commons.util.comparison

Enum CmpUtil.NullOrdering

java.lang.Object

java.lang.Enum<CmpUtil.NullOrdering>

net.automatalib.commons.util.comparison.CmpUtil.NullOrdering

All Implemented Interfaces:

Serializable, Comparable<CmpUtil.NullOrdering>

Enclosing class:

CmpUtil

public static enum CmpUtil.NullOrdering
extends Enum<CmpUtil.NullOrdering>

Enum for controlling which rank is assigned to a null element when using a safe comparator (CmpUtil.safeComparator(Comparator, NullOrdering)).

Author:

Malte Isberner

Enum Constant Summary

Enum Constants

Enum Constant and Description
MAX null elements are bigger than all regular elements.
MIN null elements are smaller than all regular elements.

Field Summary

Fields

Modifier and Type	Field and Description
int	firstNullResult Value that determines the result of the comparison, when only the first value is a null value.

Method Summary

Methods

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MIN

public static final CmpUtil.NullOrdering MIN

null elements are smaller than all regular elements.

MAX

public static final CmpUtil.NullOrdering MAX

null elements are bigger than all regular elements.

Field Detail

firstNullResult

public final int firstNullResult

Value that determines the result of the comparison, when only the first value is a null value.

Method Detail

values

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

Returns:

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

valueOf

public static CmpUtil.NullOrdering valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null