broadwick.utils

Class Pair<A,B>

java.lang.Object

broadwick.utils.Pair<A,B>

Type Parameters:

A - the type of the first element in pair.

B - the type of the second element in the pair.

All Implemented Interfaces:

Serializable

public class Pair<A,B>
extends Object
implements Serializable

HashMap compatible Pair class (i.e. a Collection that stores exactly 2 non-null objects and is not mutable). They respect equals and may be used as indices or map keys.

Note that they do not protect from malevolent behavior: if one or another object in the tuple is mutable, then it can be changed with the usual bad effects.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private A	first
private B	second

Constructor Summary

Constructors

Constructor and Description
Pair(A first, B second) Create the pair object with the given coordinates.

Method Summary

Modifier and Type	Method and Description
String	toString() Generate a string describing this pair object.

Methods inherited from class java.lang.Object

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

Field Detail

first

private A first

second

private B second

Constructor Detail

Pair

public Pair(A first,
            B second)

Create the pair object with the given coordinates.

Parameters:

first - the first element in the pair

second - the second element in the pair

Method Detail

toString

public final String toString()

Generate a string describing this pair object.

Overrides:

toString in class Object

Returns:

the description of this object.