de.aristaflow.adept2.util.types

Class Pair<F,S>

java.lang.Object

de.aristaflow.adept2.util.types.Pair<F,S>

Type Parameters:

F - The type of the first element of the pair.

S - The type of the second element of the pair.

Direct Known Subclasses:

SerialisablePair

public class Pair<F,S>
extends java.lang.Object

Class representing a pair of two objects.

Author:

Bastian Gloeckle

Field Summary

Fields

Modifier and Type	Field and Description
protected F	first The first element of the pair.
protected S	second The second element of the pair.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Pair() Default constructor for serialisation.
	Pair(F first, S second) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
F	getFirst()
S	getSecond()
int	hashCode()
static <F,S> Pair<F,S>	pair(F f, S s) Create a new pair.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

first

protected F first

The first element of the pair. Subclasses need to ensure that the element is treated like final. However for serialisation final is not possible.

second

protected S second

The second element of the pair. Subclasses need to ensure that the element is treated like final. However for serialisation final is not possible.

Constructor Detail

Pair

protected Pair()

Default constructor for serialisation. Subclasses need to set the elements appropriately!

Pair

public Pair(F first,
            S second)

Constructor.

Parameters:

first - The first element of the pair.

second - The second element of the pair.

Method Detail

getFirst

public F getFirst()

Returns:

The first element of the pair.

getSecond

public S getSecond()

Returns:

The second element of the pair.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

pair

public static <F,S> Pair<F,S> pair(F f,
                                   S s)

Create a new pair. Calling this is much shorter than calling the constructor.

Parameters:

f - First

s - Second

Returns:

A pair of first, second.