speiger.src.collections.chars.misc.pairs

Interface CharObjectPair<V>

Type Parameters:

V - the keyType of elements maintained by this Collection

All Known Implementing Classes:

CharObjectImmutablePair, CharObjectMutablePair

public interface CharObjectPair<V>

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

Field Summary

Fields

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

Method Summary

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

Field Detail

EMPTY

static final CharObjectPair<?> EMPTY

Empty Reference for Immutable Pairs

Method Detail

of

static <V> CharObjectPair<V> of()

Type Parameters:

V - the keyType of elements maintained by this Collection

Returns:

empty Immutable Pair

ofKey

static <V> CharObjectPair<V> ofKey(char key)

Type Parameters:

V - the keyType of elements maintained by this Collection

Parameters:

key - the key that should be in the pair

Returns:

Immutable Pair of Key

ofValue

static <V> CharObjectPair<V> ofValue(V value)

Type Parameters:

V - the keyType of elements maintained by this Collection

Parameters:

value - the value that should be in the pair

Returns:

Immutable Pair of Value

of

static <V> CharObjectPair<V> of(char key,
                                V value)

Type Parameters:

V - the keyType 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 <V> CharObjectPair<V> of(CharObjectPair<V> pair)

Type Parameters:

V - the keyType 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 <V> CharObjectPair<V> mutable()

Type Parameters:

V - the keyType of elements maintained by this Collection

Returns:

empty Mutable Pair

mutableKey

static <V> CharObjectPair<V> mutableKey(char key)

Type Parameters:

V - the keyType of elements maintained by this Collection

Parameters:

key - the key that should be in the pair

Returns:

Mutable Pair of key

mutableValue

static <V> CharObjectPair<V> mutableValue(V value)

Type Parameters:

V - the keyType of elements maintained by this Collection

Parameters:

value - the value that should be in the pair

Returns:

Mutable Pair of value

mutable

static <V> CharObjectPair<V> mutable(char key,
                                     V value)

Type Parameters:

V - the keyType 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 <V> CharObjectPair<V> mutable(CharObjectPair<V> pair)

Type Parameters:

V - the keyType of elements maintained by this Collection

Parameters:

pair - the Pair that should be copied

Returns:

a Mutable Copy of the Provided Pair

setCharKey

CharObjectPair<V> setCharKey(char 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.

getCharKey

char getCharKey()

Returns:

the Key of the Pair

setValue

CharObjectPair<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

CharObjectPair<V> set(char 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

CharObjectPair<V> shallowCopy()

Clones the Pair if it is mutable.

Returns:

a New Mutable Instance if it is mutable