com.diffplug.common.base

Enum Comparison

java.lang.Object

java.lang.Enum<Comparison>

com.diffplug.common.base.Comparison

All Implemented Interfaces:

Serializable, Comparable<Comparison>

public enum Comparison
extends Enum<Comparison>

Safe representation of the result of a comparison (better than int).

Enum Constant Summary

Enum Constants

Enum Constant and Description
EQUAL
GREATER
LESSER

Method Summary

Modifier and Type	Method and Description
static <T> Comparison	compare(Comparator<T> comparator, T a, T b) Compares the two objects using the Comparator.
static <T extends Comparable<T>> Comparison	compare(T a, T b) Compares the two Comparables and returns the result.
static Comparison	from(int compareToResult) Returns a Comparison from the given result of a call to Comparable.compareTo(Object) or Comparator.compare(Object, Object).
<T> T	lesserEqualGreater(T lesser, T equal, T greater) Returns the appropriate T based on the Comparison value.
static Comparison	valueOf(String name) Returns the enum constant of this type with the specified name.
static Comparison[]	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

LESSER

public static final Comparison LESSER

EQUAL

public static final Comparison EQUAL

GREATER

public static final Comparison GREATER

Method Detail

values

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

Returns:

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

valueOf

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

lesserEqualGreater

@CheckReturnValue
 @Nullable
public <T> T lesserEqualGreater(@Nullable
                                                             T lesser,
                                                             @Nullable
                                                             T equal,
                                                             @Nullable
                                                             T greater)

Returns the appropriate T based on the Comparison value.

compare

@CheckReturnValue
public static <T extends Comparable<T>> Comparison compare(T a,
                                                                             T b)

Compares the two Comparables and returns the result.

compare

@CheckReturnValue
public static <T> Comparison compare(Comparator<T> comparator,
                                                       @Nullable
                                                       T a,
                                                       @Nullable
                                                       T b)

Compares the two objects using the Comparator.

from

@CheckReturnValue
public static Comparison from(int compareToResult)

Returns a Comparison from the given result of a call to Comparable.compareTo(Object) or Comparator.compare(Object, Object).