org.plumelib.util

Class Pair<T1,T2>

java.lang.Object

org.plumelib.util.Pair<T1,T2>

Type Parameters:

T1 - the type of the first element of the pair

T2 - the type of the second element of the pair

public class Pair<T1,T2>
extends java.lang.Object

Mutable pair class: type-safely holds two objects of possibly-different types. Defines toString(), equals(), and hashCode() routines. It is also used by OrderedPairIterator. If you don't need these features, you are better off defining your own tiny class.

Field Summary

Fields

Modifier and Type	Field and Description
T1	a The first element of the pair.
T2	b The second element of the pair.

Constructor Summary

Constructors

Constructor and Description
Pair(T1 a, T2 b) Make a new pair.

Method Summary

Modifier and Type	Method and Description
boolean	equals(@GuardSatisfied @Nullable java.lang.Object obj)
int	hashCode()
static <A,B> Pair<A,B>	of(A a, B b) Factory method with short name and no need to name type parameters.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

a

public T1 a

The first element of the pair.

b

public T2 b

The second element of the pair.

Constructor Detail

Pair

public Pair(T1 a,
            T2 b)

Make a new pair.

Parameters:

a - the first element of the pair

b - the second element of the pair

Method Detail

of

public static <A,B> Pair<A,B> of(A a,
                                 B b)

Factory method with short name and no need to name type parameters.

Type Parameters:

A - type of first argument

B - type of second argument

Parameters:

a - first argument

b - second argument

Returns:

a pair of the values (a, b)

toString

@SideEffectFree
public java.lang.String toString(@GuardSatisfied Pair<T1,T2> this)

Overrides:

toString in class java.lang.Object

equals

@Pure
public boolean equals(@GuardSatisfied Pair<T1,T2> this,
                            @GuardSatisfied @Nullable java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

@Pure
public int hashCode(@GuardSatisfied Pair<T1,T2> this)

Overrides:

hashCode in class java.lang.Object