de.bioforscher.singa.core.utility

Class Pair<ValueType>

java.lang.Object

de.bioforscher.singa.core.utility.Pair<ValueType>

Type Parameters:

ValueType - The type values to be stored in the pair.

Direct Known Subclasses:

CommutablePair

public class Pair<ValueType>
extends Object

A Pair is a composition of two objects. This should only be used to return two connected objects because of Java's limited ability to return multiple values. The values of a Pair are therefore final.
The values are not exchangeable. The Pair (1,2) is not equal to (2,1).

Constructor Summary

Constructors

Constructor and Description
Pair(ValueType first, ValueType second) Creates a new Pair.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
ValueType	getFirst() Returns the first value.
ValueType	getSecond() Returns the second value.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Pair

public Pair(ValueType first,
            ValueType second)

Creates a new Pair.

Parameters:

first - The first value.

second - The second value.

Method Detail

getFirst

public ValueType getFirst()

Returns the first value.

Returns:

The first value.

getSecond

public ValueType getSecond()

Returns the second value.

Returns:

The second value.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object