net.pwall.util

Class ComparablePair<F extends Comparable<? super F>,S extends Comparable<? super S>>

java.lang.Object

net.pwall.util.Pair<F,S>

net.pwall.util.ComparablePair<F,S>

Type Parameters:

F - the class of the first object

S - the class of the second object

All Implemented Interfaces:

Serializable, Comparable<ComparablePair<F,S>>

public class ComparablePair<F extends Comparable<? super F>,S extends Comparable<? super S>>
extends Pair<F,S>
implements Comparable<ComparablePair<F,S>>

A comparable pair of objects. Both of the objects must themselves be Comparable.

Author:

Peter Wall

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ComparablePair(F first, S second) Construct a ComparablePair with the given values.

Method Summary

Modifier and Type	Method and Description
int	compareTo(ComparablePair<F,S> o) Compare this object with another for order.
static <F extends Comparable<? super F>,S extends Comparable<? super S>> ComparablePair<F,S>	create(F first, S second) Create a ComparablePair, automatically deriving the classes of the objects.

Methods inherited from class net.pwall.util.Pair

equals, getFirst, getSecond, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ComparablePair

public ComparablePair(F first,
                      S second)

Construct a ComparablePair with the given values.

Parameters:

first - the value for the first object

second - the value for the second object

Method Detail

compareTo

public int compareTo(ComparablePair<F,S> o)

Compare this object with another for order. The order is dependent on the order of the first objects of each ComparablePair, or if they are equal, on the order of the second objects.

Specified by:

compareTo in interface Comparable<ComparablePair<F extends Comparable<? super F>,S extends Comparable<? super S>>>

Parameters:

o - the other object

Returns:

a negative value, zero, or a positive value, depending on whether this object is less than, equal to, or greater than the other object

See Also:

Comparable.compareTo(Object)

create

public static <F extends Comparable<? super F>,S extends Comparable<? super S>> ComparablePair<F,S> create(F first,
                                                                                                           S second)

Create a ComparablePair, automatically deriving the classes of the objects.

Type Parameters:

F - Class of first object

S - Class of second object

Parameters:

first - the value for the first object

second - the value for the second object

Returns:

the newly-constructed ComparablePair