speiger.src.collections.chars.misc.pairs

Interface CharCharPair

All Known Implementing Classes:

CharCharImmutablePair, CharCharMutablePair

public interface CharCharPair

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

Field Summary

Fields

Modifier and Type	Field and Description
static CharCharPair	EMPTY Empty Reference for Immutable Pairs

Method Summary

Modifier and Type	Method and Description
char	getCharKey()
char	getCharValue()
static CharCharPair	mutable()
static CharCharPair	mutable(char key, char value)
static CharCharPair	mutable(CharCharPair pair)
static CharCharPair	mutableKey(char key)
static CharCharPair	mutableValue(char value)
static CharCharPair	of()
static CharCharPair	of(char key, char value)
static CharCharPair	of(CharCharPair pair)
static CharCharPair	ofKey(char key)
static CharCharPair	ofValue(char value)
CharCharPair	set(char key, char value) Sets key and value of the Pair
CharCharPair	setCharKey(char key) Sets the Key of the Pair.
CharCharPair	setCharValue(char value) Sets the Value of the Pair.
CharCharPair	shallowCopy() Clones the Pair if it is mutable.

Field Detail

EMPTY

static final CharCharPair EMPTY

Empty Reference for Immutable Pairs

Method Detail

of

static CharCharPair of()

Returns:

empty Immutable Pair

ofKey

static CharCharPair ofKey(char key)

Parameters:

key - the key that should be in the pair

Returns:

Immutable Pair of Key

ofValue

static CharCharPair ofValue(char value)

Parameters:

value - the value that should be in the pair

Returns:

Immutable Pair of Value

of

static CharCharPair of(char key,
                       char value)

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 CharCharPair of(CharCharPair pair)

Parameters:

pair - the Pair that should be immutably copied

Returns:

a Immutable Copy of the Provided Pair

mutable

static CharCharPair mutable()

Returns:

empty Mutable Pair

mutableKey

static CharCharPair mutableKey(char key)

Parameters:

key - the key that should be in the pair

Returns:

Mutable Pair of key

mutableValue

static CharCharPair mutableValue(char value)

Parameters:

value - the value that should be in the pair

Returns:

Mutable Pair of value

mutable

static CharCharPair mutable(char key,
                            char value)

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 CharCharPair mutable(CharCharPair pair)

Parameters:

pair - the Pair that should be copied

Returns:

a Mutable Copy of the Provided Pair

setCharKey

CharCharPair 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

setCharValue

CharCharPair setCharValue(char 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.

getCharValue

char getCharValue()

Returns:

the Value of the Pair

set

CharCharPair set(char key,
                 char 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

CharCharPair shallowCopy()

Clones the Pair if it is mutable.

Returns:

a New Mutable Instance if it is mutable