org.meanbean.test.internal

Enum EqualityTest

java.lang.Object

java.lang.Enum<EqualityTest>

org.meanbean.test.internal.EqualityTest

All Implemented Interfaces:

Serializable, Comparable<EqualityTest>

public enum EqualityTest
extends Enum<EqualityTest>

Equality test of two objects.

Author:

Graham Williamson

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABSOLUTE Test the absolute equality of two objects (x == y).
LOGICAL Test the logical equality of two objects (x.equals(y)).

Method Summary

Modifier and Type	Method and Description
abstract boolean	test(Object x, Object y) Is object x equal to object y.
static EqualityTest	valueOf(String name) Returns the enum constant of this type with the specified name.
static EqualityTest[]	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

LOGICAL

public static final EqualityTest LOGICAL

Test the logical equality of two objects (x.equals(y)).

ABSOLUTE

public static final EqualityTest ABSOLUTE

Test the absolute equality of two objects (x == y).

Method Detail

values

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

Returns:

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

valueOf

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

test

public abstract boolean test(Object x,
                             Object y)

Is object x equal to object y.

Parameters:

x - The first object to compare.

y - The second object to compare.

Returns:

true if the objects are considered equal; false otherwise.