org.perro.functions.internal

Class Pair<K,V>

java.lang.Object

org.perro.functions.internal.Pair<K,V>

Type Parameters:

K - The type of the key or left object.

V - The type of the value or right object.

All Implemented Interfaces:

java.util.Map.Entry<K,V>

public class Pair<K,V>
extends java.lang.Object
implements java.util.Map.Entry<K,V>

Although this class resides in the "internal" package, it will be returned as the result of some of the mapping functions built by the MapperUtils methods. It can be referred to directly since it is a public class, although to avoid dependencies on it, it may be wise to just refer to its type as the Java Map.Entry interface. This will allow you to only to use the getKey() and getValue() methods, however, they are functionally the same as getLeft() and getRight().

Method Summary

Modifier and Type	Method and Description
K	getKey() Getter for the map entry key, or left object in the pair.
K	getLeft() Getter for the map entry key, or left object in the pair.
V	getRight() Getter for the map entry value, or right object in the pair.
V	getValue() Getter for the map entry value, or right object in the pair.
static <K,V> Pair<K,V>	of(K key, V value) Builds an object of this type using the given key and value instances.
V	setValue(V value) Because this is an immutable map entry object, this method is not unsupported.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map.Entry

comparingByKey, comparingByKey, comparingByValue, comparingByValue, equals, hashCode

Method Detail

of

public static <K,V> Pair<K,V> of(K key,
                                 V value)

Builds an object of this type using the given key and value instances.

Type Parameters:

K - The type of the key or left object.

V - The type of the value or right object.

Parameters:

key - The key of the map entry, or left object in the pair.

value - The value of the map entry, or right object in the pair.

Returns:

A map entry, or pair object.

getKey

public K getKey()

Getter for the map entry key, or left object in the pair.

Specified by:

getKey in interface java.util.Map.Entry<K,V>

Returns:

The key or left object.

getValue

public V getValue()

Getter for the map entry value, or right object in the pair.

Specified by:

getValue in interface java.util.Map.Entry<K,V>

Returns:

The value or right object.

setValue

public V setValue(V value)

Because this is an immutable map entry object, this method is not unsupported.

Specified by:

setValue in interface java.util.Map.Entry<K,V>

Throws:

java.lang.UnsupportedOperationException - Always throws this exception.

getLeft

public K getLeft()

Getter for the map entry key, or left object in the pair.

Returns:

The key or left object.

getRight

public V getRight()

Getter for the map entry value, or right object in the pair.

Returns:

The value or right object.