org.conqat.lib.commons.collections

Class ImmutablePair<S,T>

java.lang.Object

org.conqat.lib.commons.collections.ImmutablePair<S,T>

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<ImmutablePair<S,T>>

Direct Known Subclasses:

Pair

public class ImmutablePair<S,T>
extends java.lang.Object
implements java.lang.Cloneable, java.lang.Comparable<ImmutablePair<S,T>>, java.io.Serializable

Simple readonly pair class.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected S	first The first element.
protected T	second The second element.

Constructor Summary

Constructors

Constructor and Description
ImmutablePair(ImmutablePair<S,T> p) Copy constructor.
ImmutablePair(S first, T second) Constructor.

Method Summary

Modifier and Type	Method and Description
protected ImmutablePair<S,T>	clone()
int	compareTo(ImmutablePair<S,T> pair)
boolean	equals(java.lang.Object obj)
S	getFirst() Returns the first element of the pair.
T	getSecond() Returns the second element of the pair.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

first

protected S first

The first element.

second

protected T second

The second element.

Constructor Detail

ImmutablePair

public ImmutablePair(S first,
                     T second)

Constructor.

ImmutablePair

public ImmutablePair(ImmutablePair<S,T> p)

Copy constructor.

Method Detail

getFirst

public S getFirst()

Returns the first element of the pair.

getSecond

public T getSecond()

Returns the second element of the pair.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

The hash code is based on the hash code of the first and second members.

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

clone

protected ImmutablePair<S,T> clone()

Overrides:

clone in class java.lang.Object

compareTo

public int compareTo(ImmutablePair<S,T> pair)

Compare based on first element. Use second element only if first elements are equal. Null entries are sorted to the top.

Specified by:

compareTo in interface java.lang.Comparable<ImmutablePair<S,T>>