org.incava.ijdk.lang

Class Comp

java.lang.Object

org.incava.ijdk.lang.Comp

public class Comp
extends java.lang.Object

Extensions to the Comparable interface. This normalizes the return value to -1, 0, and 1, and has the methods lt, lte, gt, gte, which parallel the equals method. This is similar to Ruby, where defining the <=> method (the "spaceship" method) results in the equivalent generation of <, <=, etc.

Constructor Summary

Constructors

Constructor and Description
Comp()

Method Summary

Modifier and Type	Method and Description
static <Type extends java.lang.Comparable<Type>> int	compare(Type x, Type y) Compares the two objects, including testing for null.
static <Type extends java.lang.Comparable<Type>> boolean	greaterThan(Type x, Type y) Returns whether x is greater than y.
static <Type extends java.lang.Comparable<Type>> boolean	gt(Type x, Type y) Returns whether x is greater than y.
static <Type extends java.lang.Comparable<Type>> boolean	gte(Type x, Type y) Returns whether x is greater than or equal to y.
static <Type extends java.lang.Comparable<Type>> boolean	lessThan(Type x, Type y) Returns whether x is less than y.
static <Type extends java.lang.Comparable<Type>> boolean	lt(Type x, Type y) Returns whether x is less than y.
static <Type extends java.lang.Comparable<Type>> boolean	lte(Type x, Type y) Returns whether x is less than or equal to y.

Methods inherited from class java.lang.Object

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

Constructor Detail

Comp

public Comp()

Method Detail

compare

public static <Type extends java.lang.Comparable<Type>> int compare(Type x,
                                                                    Type y)

Compares the two objects, including testing for null. Returns only -1, 0, or 1.

Type Parameters:

Type - the type, which is Comparable

Parameters:

x - the first value

y - the second value

Returns:

the comparison value

lessThan

public static <Type extends java.lang.Comparable<Type>> boolean lessThan(Type x,
                                                                         Type y)

Returns whether x is less than y.

Type Parameters:

Type - the type, which is Comparable

Parameters:

x - the first value

y - the second value

Returns:

whether x is less than y

lt

public static <Type extends java.lang.Comparable<Type>> boolean lt(Type x,
                                                                   Type y)

Returns whether x is less than y.

Type Parameters:

Type - the type, which is Comparable

Parameters:

x - the first value

y - the second value

Returns:

whether x is less than y

lte

public static <Type extends java.lang.Comparable<Type>> boolean lte(Type x,
                                                                    Type y)

Returns whether x is less than or equal to y.

Type Parameters:

Type - the type, which is Comparable

Parameters:

x - the first value

y - the second value

Returns:

whether x is less than or equal to y

greaterThan

public static <Type extends java.lang.Comparable<Type>> boolean greaterThan(Type x,
                                                                            Type y)

Returns whether x is greater than y.

Type Parameters:

Type - the type, which is Comparable

Parameters:

x - the first value

y - the second value

Returns:

whether x is greater than y

gt

public static <Type extends java.lang.Comparable<Type>> boolean gt(Type x,
                                                                   Type y)

Returns whether x is greater than y.

Type Parameters:

Type - the type, which is Comparable

Parameters:

x - the first value

y - the second value

Returns:

whether x is greater than y

gte

public static <Type extends java.lang.Comparable<Type>> boolean gte(Type x,
                                                                    Type y)

Returns whether x is greater than or equal to y.

Type Parameters:

Type - the type, which is Comparable

Parameters:

x - the first value

y - the second value

Returns:

whether x is greater than or equal to y