speiger.src.collections.objects.misc.pairs

Interface ObjectObjectPair<T,V>

Type Parameters:

T - the type of elements maintained by this Collection

V - the type of elements maintained by this Collection

All Known Implementing Classes:

ObjectObjectImmutablePair, ObjectObjectMutablePair

public interface ObjectObjectPair<T,V>

Key Value Pair Interface that allows to reduce boxing/unboxing.

Field Summary

Fields

Modifier and Type	Field and Description
static ObjectObjectPair<?,?>	EMPTY Empty Reference for Immutable Pairs

Method Summary

Modifier and Type	Method and Description
T	getKey()
V	getValue()
static <T,V> ObjectObjectPair<T,V>	mutable()
static <T,V> ObjectObjectPair<T,V>	mutable(ObjectObjectPair<T,V> pair)
static <T,V> ObjectObjectPair<T,V>	mutable(T key, V value)
static <T,V> ObjectObjectPair<T,V>	mutableKey(T key)
static <T,V> ObjectObjectPair<T,V>	mutableValue(V value)
static <T,V> ObjectObjectPair<T,V>	of()
static <T,V> ObjectObjectPair<T,V>	of(ObjectObjectPair<T,V> pair)
static <T,V> ObjectObjectPair<T,V>	of(T key, V value)
static <T,V> ObjectObjectPair<T,V>	ofKey(T key)
static <T,V> ObjectObjectPair<T,V>	ofValue(V value)
ObjectObjectPair<T,V>	set(T key, V value) Sets key and value of the Pair
ObjectObjectPair<T,V>	setKey(T key) Sets the Key of the Pair.
ObjectObjectPair<T,V>	setValue(V value) Sets the Value of the Pair.
ObjectObjectPair<T,V>	shallowCopy() Clones the Pair if it is mutable.

Field Detail

EMPTY

static final ObjectObjectPair<?,?> EMPTY

Empty Reference for Immutable Pairs

Method Detail

of

static <T,V> ObjectObjectPair<T,V> of()

Type Parameters:

T - the type of elements maintained by this Collection

V - the type of elements maintained by this Collection

Returns:

empty Immutable Pair

ofKey

static <T,V> ObjectObjectPair<T,V> ofKey(T key)

Type Parameters:

T - the type of elements maintained by this Collection

V - the type of elements maintained by this Collection

Parameters:

key - the key that should be in the pair

Returns:

Immutable Pair of Key

ofValue

static <T,V> ObjectObjectPair<T,V> ofValue(V value)

Type Parameters:

T - the type of elements maintained by this Collection

V - the type of elements maintained by this Collection

Parameters:

value - the value that should be in the pair

Returns:

Immutable Pair of Value

of

static <T,V> ObjectObjectPair<T,V> of(T key,
                                      V value)

Type Parameters:

T - the type of elements maintained by this Collection

V - the type of elements maintained by this Collection

Parameters:

key - the key that should be in the pair

value - the value that should be in the pair

Returns:

Immutable Pair of key and value

of

static <T,V> ObjectObjectPair<T,V> of(ObjectObjectPair<T,V> pair)

Type Parameters:

T - the type of elements maintained by this Collection

V - the type of elements maintained by this Collection

Parameters:

pair - the Pair that should be immutably copied

Returns:

a Immutable Copy of the Provided Pair

mutable

static <T,V> ObjectObjectPair<T,V> mutable()

Type Parameters:

T - the type of elements maintained by this Collection

V - the type of elements maintained by this Collection

Returns:

empty Mutable Pair

mutableKey

static <T,V> ObjectObjectPair<T,V> mutableKey(T key)

Type Parameters:

T - the type of elements maintained by this Collection

V - the type of elements maintained by this Collection

Parameters:

key - the key that should be in the pair

Returns:

Mutable Pair of key

mutableValue

static <T,V> ObjectObjectPair<T,V> mutableValue(V value)

Type Parameters:

T - the type of elements maintained by this Collection

V - the type of elements maintained by this Collection

Parameters:

value - the value that should be in the pair

Returns:

Mutable Pair of value

mutable

static <T,V> ObjectObjectPair<T,V> mutable(T key,
                                           V value)

Type Parameters:

T - the type of elements maintained by this Collection

V - the type of elements maintained by this Collection

Parameters:

key - the key that should be in the pair

value - the value that should be in the pair

Returns:

Mutable Pair of key and value

mutable

static <T,V> ObjectObjectPair<T,V> mutable(ObjectObjectPair<T,V> pair)

Type Parameters:

T - the type of elements maintained by this Collection

V - the type of elements maintained by this Collection

Parameters:

pair - the Pair that should be copied

Returns:

a Mutable Copy of the Provided Pair

setKey

ObjectObjectPair<T,V> setKey(T key)

Sets the Key of the Pair.

Parameters:

key - the key that should be set.

Returns:

self or a new Pair instance with the new key.

getKey

T getKey()

Returns:

the Key of the Pair

setValue

ObjectObjectPair<T,V> setValue(V value)

Sets the Value of the Pair.

Parameters:

value - the value that should be set.

Returns:

self or a new Pair instance with the new value.

getValue

V getValue()

Returns:

the Value of the Pair

set

ObjectObjectPair<T,V> set(T key,
                          V value)

Sets key and value of the Pair

Parameters:

key - the key that should be set.

value - the value that should be set.

Returns:

self or a new Pair instance with the new key and value.

shallowCopy

ObjectObjectPair<T,V> shallowCopy()

Clones the Pair if it is mutable.

Returns:

a New Mutable Instance if it is mutable