org.gytheio.util

Enum EqualsHelper.MapValueComparison

java.lang.Object

java.lang.Enum<EqualsHelper.MapValueComparison>

org.gytheio.util.EqualsHelper.MapValueComparison

All Implemented Interfaces:

Serializable, Comparable<EqualsHelper.MapValueComparison>

Enclosing class:

EqualsHelper

public static enum EqualsHelper.MapValueComparison
extends Enum<EqualsHelper.MapValueComparison>

Enumeration for results returned by map comparisons.

Since:

3.3

Author:

Derek Hulley

Enum Constant Summary

Enum Constants

Enum Constant and Description
EQUAL The key was present in both maps and the values were equal
LEFT_ONLY The key was only present in the left map
NOT_EQUAL The key was present in both maps but not equal
RIGHT_ONLY The key was only present in the right map

Method Summary

Methods

Modifier and Type	Method and Description
static EqualsHelper.MapValueComparison	valueOf(String name) Returns the enum constant of this type with the specified name.
static EqualsHelper.MapValueComparison[]	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

LEFT_ONLY

public static final EqualsHelper.MapValueComparison LEFT_ONLY

The key was only present in the left map

RIGHT_ONLY

public static final EqualsHelper.MapValueComparison RIGHT_ONLY

The key was only present in the right map

EQUAL

public static final EqualsHelper.MapValueComparison EQUAL

The key was present in both maps and the values were equal

NOT_EQUAL

public static final EqualsHelper.MapValueComparison NOT_EQUAL

The key was present in both maps but not equal

Method Detail

values

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

Returns:

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

valueOf

public static EqualsHelper.MapValueComparison 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