Package io.deephaven.util.compare

Class ObjectComparisons

java.lang.Object

io.deephaven.util.compare.ObjectComparisons

public class ObjectComparisons
extends Object

Constructor Summary

Constructors

Constructor	Description
ObjectComparisons()

Method Summary

Modifier and Type	Method	Description
static int	compare(Object lhs, Object rhs)	Compares two Objects according to the following rules: null is less than all other values Otherwise, Comparable.compareTo(Object) is used
static boolean	eq(Object lhs, Object rhs)	Compare two Objects for equality consistent with compare(Object, Object); that is compare(lhs, rhs) == 0 ⇒ eq(lhs, rhs) and compare(lhs, rhs) != 0 ⇒ !eq(lhs, rhs).
static boolean	geq(Object lhs, Object rhs)	Logically equivalent to compare(lhs, rhs) >= 0.
static boolean	gt(Object lhs, Object rhs)	Logically equivalent to compare(lhs, rhs) > 0.
static int	hashCode(Object x)	Returns a hash code for an Object value consistent with eq(Object, Object); that is, eq(x, y) ⇒ hashCode(x) == hashCode(y).
static boolean	leq(Object lhs, Object rhs)	Logically equivalent to compare(lhs, rhs) <= 0.
static boolean	lt(Object lhs, Object rhs)	Logically equivalent to compare(lhs, rhs) < 0.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ObjectComparisons

public ObjectComparisons()

Method Details

compare

public static int compare(Object lhs,
 Object rhs)

Compares two Objects according to the following rules:

• null is less than all other values
• Otherwise, Comparable.compareTo(Object) is used

Parameters:

lhs - the first value

rhs - the second value

Returns:

the value 0 if lhs is equal to rhs; a value less than 0 if lhs is less than rhs; and a value greater than 0 if lhs is greater than rhs

eq

public static boolean eq(Object lhs,
 Object rhs)

Compare two Objects for equality consistent with compare(Object, Object); that is compare(lhs, rhs) == 0 ⇒ eq(lhs, rhs) and compare(lhs, rhs) != 0 ⇒ !eq(lhs, rhs).

Logically equivalent to compare(lhs, rhs) == 0.

Parameters:

lhs - the first value

rhs - the second value

Returns:

true if the values are equal, false otherwise

hashCode

public static int hashCode(Object x)

Returns a hash code for an Object value consistent with eq(Object, Object); that is, eq(x, y) ⇒ hashCode(x) == hashCode(y).

Parameters:

x - the value to hash

Returns:

a hash code value for an Object value

gt

public static boolean gt(Object lhs,
 Object rhs)

Logically equivalent to compare(lhs, rhs) > 0.

Parameters:

lhs - the first value

rhs - the second value

Returns:

true iff lhs is greater than rhs

lt

public static boolean lt(Object lhs,
 Object rhs)

Logically equivalent to compare(lhs, rhs) < 0.

Parameters:

lhs - the first value

rhs - the second value

Returns:

true iff lhs is less than rhs

geq

public static boolean geq(Object lhs,
 Object rhs)

Logically equivalent to compare(lhs, rhs) >= 0.

Parameters:

lhs - the first value

rhs - the second value

Returns:

true iff lhs is greater than or equal to rhs

leq

public static boolean leq(Object lhs,
 Object rhs)

Logically equivalent to compare(lhs, rhs) <= 0.

Parameters:

lhs - the first value

rhs - the second value

Returns:

true iff lhs is less than or equal to rhs