org.nlpcn.commons.lang.util.tuples

Class KeyValue<A,B>

java.lang.Object

org.nlpcn.commons.lang.util.tuples.Tuple

org.nlpcn.commons.lang.util.tuples.KeyValue<A,B>

All Implemented Interfaces:

Serializable, Comparable<Tuple>, Iterable<Object>, IValueKey<A>, IValueValue<B>

public final class KeyValue<A,B>
extends Tuple
implements IValueKey<A>, IValueValue<B>

A tuple of two elements, with positions 0 and 1 renamed as "key" and "value", respectively.

Since:

1.0

Author:

Daniel Fernández

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
KeyValue(A key, B value)

Method Summary

Modifier and Type	Method and Description
static <X> KeyValue<X,X>	fromArray(X[] array) Create tuple from array.
static <X> KeyValue<X,X>	fromCollection(Collection<X> collection)
static <X> KeyValue<X,X>	fromIterable(Iterable<X> iterable)
static <X> KeyValue<X,X>	fromIterable(Iterable<X> iterable, int index)
A	getKey()
int	getSize() Return the size of the tuple.
B	getValue()
<X> KeyValue<X,B>	setKey(X key)
<Y> KeyValue<A,Y>	setValue(Y value)
static <A,B> KeyValue<A,B>	with(A key, B value)

Methods inherited from class org.nlpcn.commons.lang.util.tuples.Tuple

compareTo, contains, containsAll, containsAll, equals, getValue, hashCode, indexOf, iterator, lastIndexOf, toArray, toList, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

KeyValue

public KeyValue(A key,
                B value)

Method Detail

with

public static <A,B> KeyValue<A,B> with(A key,
                                       B value)

fromArray

public static <X> KeyValue<X,X> fromArray(X[] array)

Create tuple from array. Array has to have exactly two elements.

Type Parameters:

X - the array component type

Parameters:

array - the array to be converted to a tuple

Returns:

the tuple

fromCollection

public static <X> KeyValue<X,X> fromCollection(Collection<X> collection)

fromIterable

public static <X> KeyValue<X,X> fromIterable(Iterable<X> iterable)

fromIterable

public static <X> KeyValue<X,X> fromIterable(Iterable<X> iterable,
                                             int index)

getKey

public A getKey()

Specified by:

getKey in interface IValueKey<A>

getValue

public B getValue()

Specified by:

getValue in interface IValueValue<B>

getSize

public int getSize()

Description copied from class: Tuple

Return the size of the tuple.

Specified by:

getSize in class Tuple

Returns:

the size of the tuple.

setKey

public <X> KeyValue<X,B> setKey(X key)

setValue

public <Y> KeyValue<A,Y> setValue(Y value)