org.nerd4j.utils.lang

Interface Comparative<T>

Type Parameters:

T - the type of objects that this object may be compared to.

All Superinterfaces:

Comparable<T>

All Known Implementing Classes:

ComparablePair, ComparableTriple

public interface Comparative<T>
extends Comparable<T>

The aim of this interface is to add some convenience method to the Comparable interface.

To check if a Comparable value is greater than another you need to write:

 if( a.compareTo(b) > 0 )
   // Do something...
 

This type of statements is long to write, can make the code difficult to understand and is prone to errors.

This interface adds the following default methods:

• lt: stands for "less than"
• le: stands for "less or equal"
• eq: stands for "is equal to"
• ne: stands for "is not equal to"
• ge: stands for "greater or equal"
• gt: stands for "greater than"

This way the same statement will become

 if( a.gt(b) )
   // Do something...
 

Since:

2.0.0

Author:

Massimo Coluzzi

Method Summary

Modifier and Type	Method and Description
default boolean	eq(T other) Tells if this object is equal to the given object.
default boolean	ge(T other) Tells if this object is greater or equal than the given object.
default boolean	gt(T other) Tells if this object is greater than the given object.
default boolean	le(T other) Tells if this object is less or equal than the given object.
default boolean	lt(T other) Tells if this object is less than the given object.
default boolean	ne(T other) Tells if this object is not equal to the given object.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

lt

default boolean lt(T other)

Tells if this object is less than the given object.

Parameters:

other - the object to be compared.

Returns:

true it this is less than other.

Throws:

NullPointerException - if other is null.

le

default boolean le(T other)

Tells if this object is less or equal than the given object.

Parameters:

other - the object to be compared.

Returns:

true it this is less or equal than other.

Throws:

NullPointerException - if other is null.

eq

default boolean eq(T other)

Tells if this object is equal to the given object.

Parameters:

other - the object to be compared.

Returns:

true it this is equal to other.

Throws:

NullPointerException - if other is null.

ne

default boolean ne(T other)

Tells if this object is not equal to the given object.

Parameters:

other - the object to be compared.

Returns:

true it this is not equal to other.

Throws:

NullPointerException - if other is null.

ge

default boolean ge(T other)

Tells if this object is greater or equal than the given object.

Parameters:

other - the object to be compared.

Returns:

true it this is greater or equal than other.

Throws:

NullPointerException - if other is null.

gt

default boolean gt(T other)

Tells if this object is greater than the given object.

Parameters:

other - the object to be compared.

Returns:

true it this is greater than other.

Throws:

NullPointerException - if other is null.