net.pwall.util

Class Pair<F,S>

java.lang.Object

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

Type Parameters:

F - Class of first object

S - Class of second object

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ComparablePair

public class Pair<F,S>
extends Object
implements Serializable

A pair of objects.

Author:

Peter Wall

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static <F,S> Pair<F,S>	create(F first, S second) Create a new Pair where the types of the two objects are inferred from the types of the arguments.
boolean	equals(Object other) Compare this object to another for equality.
F	getFirst() Get the first object.
S	getSecond() Get the second object.
int	hashCode() Return the hash code for the Pair.
String	toString() Return the String representation of the Pair.

Methods inherited from class java.lang.Object

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

Constructor Detail

Pair

public Pair(F first,
            S second)

Construct a Pair with the given values.

Parameters:

first - the value for the first object

second - the value for the second object

Method Detail

getFirst

public F getFirst()

Get the first object.

Returns:

the first object

getSecond

public S getSecond()

Get the second object.

Returns:

the second object

toString

public String toString()

Return the String representation of the Pair. The default representation consists of the representations of the two objects, enclosed in parentheses and separated by a comma.

Overrides:

toString in class Object

Returns:

the string representation

See Also:

Object.toString()

hashCode

public int hashCode()

Return the hash code for the Pair. The default hash code is the exclusive OR of the hash codes of the two objects.

Overrides:

hashCode in class Object

Returns:

the hash code

See Also:

Object.hashCode()

equals

public boolean equals(Object other)

Compare this object to another for equality.

Overrides:

equals in class Object

Parameters:

other - the other object

Returns:

true if the other object is non-null, is a Pair of compatible objects, and those objects are equal

See Also:

Object.equals(Object)

create

public static <F,S> Pair<F,S> create(F first,
                                     S second)

Create a new Pair where the types of the two objects are inferred from the types of the arguments.

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 new Pair