de.mrapp.util.datastructure

Class Pair<F,S>

java.lang.Object

de.mrapp.util.datastructure.Pair<F,S>

Type Parameters:

F - The type of the first object

S - The type of the second object

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

A data structure, which eases to pass around a pair of two objects. This object provides a sensible implementation of equals(), returning true if equals() is true on each of the contained objects.

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field and Description
F	first The first object.
S	second The second object.

Constructor Summary

Constructors

Constructor and Description
Pair(F first, S second) Creates a new pair.

Method Summary

Modifier and Type	Method and Description
static <F,S> Pair<F,S>	create(F first, S second) Creates a new pair.
boolean	equals(java.lang.Object obj)
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Detail

first

public final F first

The first object.

second

public final S second

The second object.

Constructor Detail

Pair

public Pair(F first,
            S second)

Creates a new pair.

Parameters:

first - The first object as an instance of the generic type F

second - The second object as an instance of the generic type S

Method Detail

create

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

Creates a new pair.

Type Parameters:

F - The type of the first object

S - The type of the second object

Parameters:

first - The first object as an instance of the generic type F

second - The second object as an instance of the generic type S

Returns:

The pair, which has been created, as an instance of the class Pair. The pair may not be null

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public final boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object