net.sf.collections15.comparators
Enum FixedOrderComparator.UnknownObjectBehaviour

java.lang.Object
  java.lang.Enum<FixedOrderComparator.UnknownObjectBehaviour>
      net.sf.collections15.comparators.FixedOrderComparator.UnknownObjectBehaviour

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FixedOrderComparator.UnknownObjectBehaviour>

Enclosing class:

FixedOrderComparator<E>

public static enum FixedOrderComparator.UnknownObjectBehaviour
extends java.lang.Enum<FixedOrderComparator.UnknownObjectBehaviour>

Enumeration class that defines constants representing the way in which a FixedOrderComparator handles the comparison of objects which aren't part of its known ordering.

Enum Constant Summary

UNKNOWN_AFTER
Behavior when comparing unknown objects: unknown objects compare as after known objects.

UNKNOWN_BEFORE
Behavior when comparing unknown objects: unknown objects compare as before known objects.

UNKNOWN_THROW_EXCEPTION
Behavior when comparing unknown objects: unknown objects cause an IllegalArgumentException to be thrown.

Method Summary

static FixedOrderComparator.UnknownObjectBehaviour	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FixedOrderComparator.UnknownObjectBehaviour[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNKNOWN_BEFORE

public static final FixedOrderComparator.UnknownObjectBehaviour UNKNOWN_BEFORE

Behavior when comparing unknown objects: unknown objects compare as before known objects.

UNKNOWN_AFTER

public static final FixedOrderComparator.UnknownObjectBehaviour UNKNOWN_AFTER

Behavior when comparing unknown objects: unknown objects compare as after known objects.

UNKNOWN_THROW_EXCEPTION

public static final FixedOrderComparator.UnknownObjectBehaviour UNKNOWN_THROW_EXCEPTION

Behavior when comparing unknown objects: unknown objects cause an IllegalArgumentException to be thrown. This is the default behavior for a newly created FixedOrderComparator.

Method Detail

values

public static final FixedOrderComparator.UnknownObjectBehaviour[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(FixedOrderComparator.UnknownObjectBehaviour c : FixedOrderComparator.UnknownObjectBehaviour.values())
        System.out.println(c);

Returns:

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

valueOf

public static FixedOrderComparator.UnknownObjectBehaviour 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