speiger.src.collections.chars.misc.pairs

Interface CharFloatPair

All Known Implementing Classes:

CharFloatImmutablePair, CharFloatMutablePair

public interface CharFloatPair

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

Field Summary

Fields

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

Method Summary

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

Field Detail

EMPTY

static final CharFloatPair EMPTY

Empty Reference for Immutable Pairs

Method Detail

of

static CharFloatPair of()

Returns:

empty Immutable Pair

ofKey

static CharFloatPair ofKey(char key)

Parameters:

key - the key that should be in the pair

Returns:

Immutable Pair of Key

ofValue

static CharFloatPair ofValue(float value)

Parameters:

value - the value that should be in the pair

Returns:

Immutable Pair of Value

of

static CharFloatPair of(char key,
                        float 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 CharFloatPair of(CharFloatPair pair)

Parameters:

pair - the Pair that should be immutably copied

Returns:

a Immutable Copy of the Provided Pair

mutable

static CharFloatPair mutable()

Returns:

empty Mutable Pair

mutableKey

static CharFloatPair mutableKey(char key)

Parameters:

key - the key that should be in the pair

Returns:

Mutable Pair of key

mutableValue

static CharFloatPair mutableValue(float value)

Parameters:

value - the value that should be in the pair

Returns:

Mutable Pair of value

mutable

static CharFloatPair mutable(char key,
                             float 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 CharFloatPair mutable(CharFloatPair pair)

Parameters:

pair - the Pair that should be copied

Returns:

a Mutable Copy of the Provided Pair

setCharKey

CharFloatPair 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

setFloatValue

CharFloatPair setFloatValue(float 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.

getFloatValue

float getFloatValue()

Returns:

the Value of the Pair

set

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

CharFloatPair shallowCopy()

Clones the Pair if it is mutable.

Returns:

a New Mutable Instance if it is mutable