se.jiderhamn

Class CompareTo<T extends Comparable<T>>

java.lang.Object

se.jiderhamn.CompareTo<T>

public class CompareTo<T extends Comparable<T>>
extends Object

Utility class that provides more readable syntax for Comparable.compareTo(Object). Examples: import static se.jiderhamn.CompareTo.is; ... boolean oneIsZero = is(1).equalTo(0); boolean aIsNotZero = is(a).notEqualTo(0); boolean bIsZero = is(b).zero(); boolean value1LessThanValue2 = is(value1).lessThan(value2); if(is(a).lessThanOrEqualTo(b)) { ... } boolean date1AfterDate2 = is(date1).greaterThan(date2); if(is(a).greaterThanOrEqualTo(b)) { ... } // Abbreviated syntax boolean oneIsZero = is(1).eq(0); boolean aIsNotZero = is(a).ne(0); boolean value1LessThanValue2 = is(value1).lt(value2); if(is(a).le(b)) { ... } boolean date1AfterDate2 = is(date1).gt(date2); if(is(a).ge(b)) { ... }

Author:

Mattias Jiderhamn

Method Summary

Methods

Modifier and Type	Method and Description
boolean	after(T that) Is the owner after the argument?
boolean	before(T that) Is the owner before the argument?
boolean	eq(T that) Is the owner equal to the argument?
boolean	equalTo(T that) Is the owner equal to the argument?
boolean	ge(T that) Is the owner greater than or equal to the argument?
boolean	greaterThan(T that) Is the owner greater than the argument?
boolean	greaterThanOrEqualTo(T that) Is the owner greater than or equal to the argument?
boolean	gt(T that) Is the owner greater than the argument?
static <C extends Comparable<C>> CompareTo<C>	is(C comparable) Create new instance that allows for chained comparison
boolean	le(T that) Is the owner less than or equal to the argument?
boolean	lessThan(T that) Is the owner less than the argument?
boolean	lessThanOrEqualTo(T that) Is the owner less than or equal to the argument?
boolean	lt(T that) Is the owner less than the argument?
boolean	ne(T that) Is the owner not equal to the argument?
boolean	notEqualTo(T that) Is the owner not equal to the argument?
boolean	zero() Is the owner equal to zero (regardless of scale)?

Methods inherited from class java.lang.Object

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

Method Detail

is

public static <C extends Comparable<C>> CompareTo<C> is(C comparable)

Create new instance that allows for chained comparison

equalTo

public boolean equalTo(T that)

Is the owner equal to the argument? Note specifically that null equals null, but not non-null.

eq

public boolean eq(T that)

Is the owner equal to the argument? Note specifically that null equals null, but not non-null.

notEqualTo

public boolean notEqualTo(T that)

Is the owner not equal to the argument? Note specifically that null equals null, but not non-null.

ne

public boolean ne(T that)

Is the owner not equal to the argument? Note specifically that null equals null, but not non-null.

lessThan

public boolean lessThan(T that)

Is the owner less than the argument?

lessThanOrEqualTo

public boolean lessThanOrEqualTo(T that)

Is the owner less than or equal to the argument?

lt

public boolean lt(T that)

Is the owner less than the argument?

le

public boolean le(T that)

Is the owner less than or equal to the argument?

before

public boolean before(T that)

Is the owner before the argument? Same as lessThan(Comparable)

greaterThan

public boolean greaterThan(T that)

Is the owner greater than the argument?

greaterThanOrEqualTo

public boolean greaterThanOrEqualTo(T that)

Is the owner greater than or equal to the argument?

gt

public boolean gt(T that)

Is the owner greater than the argument?

ge

public boolean ge(T that)

Is the owner greater than or equal to the argument?

after

public boolean after(T that)

Is the owner after the argument? Same as greaterThan(Comparable)

zero

public boolean zero()

Is the owner equal to zero (regardless of scale)? Supported types are Integer, Long, Short, Byte, Float, Double and BigDecimal. Note that is(null).zero() == false.

Throws:

IllegalArgumentException - for any non-numeric owner type.