fr.cnes.sirius.patrius.math.util

Class Pair<K,V>

java.lang.Object

fr.cnes.sirius.patrius.math.util.Pair<K,V>

Type Parameters:

K - Key type.

V - Value type.

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

PointValuePair, PointVectorValuePair

public class Pair<K,V>
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.

Since:

3.0

Version:

$Id: Pair.java 18108 2017-10-04 06:45:27Z bignon $

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Pair(K k, V v) Create an entry representing a mapping from the specified key to the specified value.
Pair(Pair<? extends K,? extends V> entry) Create an entry representing the same mapping as the specified entry.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
K	getFirst() Getter for the first element of the pair.
K	getKey() Getter for the key.
V	getSecond() Getter for the second element of the pair.
V	getValue() Getter for the value.
int	hashCode()
String	toString() Display the key and the value of the pair.

Methods inherited from class java.lang.Object

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

Constructor Detail

Pair

public Pair(K k,
            V v)

Create an entry representing a mapping from the specified key to the specified value.

Parameters:

k - Key (first element of the pair)

v - Value (second element of the pair)

Pair

public Pair(Pair<? extends K,? extends V> entry)

Create an entry representing the same mapping as the specified entry.

Parameters:

entry - Entry to copy

Method Detail

getKey

public K getKey()

Getter for the key.

Returns:

the key (first element of the pair).

getValue

public V getValue()

Getter for the value.

Returns:

the value (second element of the pair).

getFirst

public K getFirst()

Getter for the first element of the pair.

Returns:

the first element of the pair.

Since:

3.1

getSecond

public V getSecond()

Getter for the second element of the pair.

Returns:

the second element of the pair.

Since:

3.1

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Display the key and the value of the pair.

Overrides:

toString in class Object

Returns:

String : the key and the value (k,v) contained in the pair