org.jgrapht.alg.util

Class Pair<A,B>

java.lang.Object

org.jgrapht.alg.util.Pair<A,B>

Type Parameters:

A - the first element type

B - the second element type

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

UnorderedPair

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

Generic pair.

Although the instances of this class are immutable, it is impossible to ensure that the references passed to the constructor will not be modified by the caller.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected A	first The first pair element
protected B	second The second pair element

Constructor Summary

Constructors

Constructor and Description
Pair(A a, B b) Create a new pair

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
A	getFirst() Get the first element of the pair
B	getSecond() Get the second element of the pair
<E> boolean	hasElement(E e) Assess if this pair contains an element.
int	hashCode()
static <A,B> Pair<A,B>	of(A a, B b) Creates new pair of elements pulling of the necessity to provide corresponding types of the elements supplied.
void	setFirst(A f) Set the first element of the pair.
void	setSecond(B s) Set the second element of the pair.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

first

protected A first

The first pair element

second

protected B second

The second pair element

Constructor Detail

Pair

public Pair(A a,
            B b)

Create a new pair

Parameters:

a - the first element

b - the second element

Method Detail

getFirst

public A getFirst()

Get the first element of the pair

Returns:

the first element of the pair

getSecond

public B getSecond()

Get the second element of the pair

Returns:

the second element of the pair

setFirst

public void setFirst(A f)

Set the first element of the pair.

Parameters:

f - the element to be assigned.

setSecond

public void setSecond(B s)

Set the second element of the pair.

Parameters:

s - the element to be assigned.

hasElement

public <E> boolean hasElement(E e)

Assess if this pair contains an element.

Type Parameters:

E - the element type

Parameters:

e - The element in question

Returns:

true if contains the element, false otherwise

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

of

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

Creates new pair of elements pulling of the necessity to provide corresponding types of the elements supplied.

Type Parameters:

A - the first element type

B - the second element type

Parameters:

a - first element

b - second element

Returns:

new pair