speiger.src.collections.floats.misc.pairs

Interface FloatCharPair

All Known Implementing Classes:

FloatCharImmutablePair, FloatCharMutablePair

public interface FloatCharPair

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

Field Summary

Fields

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

Method Summary

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

Field Detail

EMPTY

static final FloatCharPair EMPTY

Empty Reference for Immutable Pairs

Method Detail

of

static FloatCharPair of()

Returns:

empty Immutable Pair

ofKey

static FloatCharPair ofKey(float key)

Parameters:

key - the key that should be in the pair

Returns:

Immutable Pair of Key

ofValue

static FloatCharPair ofValue(char value)

Parameters:

value - the value that should be in the pair

Returns:

Immutable Pair of Value

of

static FloatCharPair of(float 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 FloatCharPair of(FloatCharPair pair)

Parameters:

pair - the Pair that should be immutably copied

Returns:

a Immutable Copy of the Provided Pair

mutable

static FloatCharPair mutable()

Returns:

empty Mutable Pair

mutableKey

static FloatCharPair mutableKey(float key)

Parameters:

key - the key that should be in the pair

Returns:

Mutable Pair of key

mutableValue

static FloatCharPair mutableValue(char value)

Parameters:

value - the value that should be in the pair

Returns:

Mutable Pair of value

mutable

static FloatCharPair mutable(float 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 FloatCharPair mutable(FloatCharPair pair)

Parameters:

pair - the Pair that should be copied

Returns:

a Mutable Copy of the Provided Pair

setFloatKey

FloatCharPair setFloatKey(float 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.

getFloatKey

float getFloatKey()

Returns:

the Key of the Pair

setCharValue

FloatCharPair 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

FloatCharPair set(float 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

FloatCharPair shallowCopy()

Clones the Pair if it is mutable.

Returns:

a New Mutable Instance if it is mutable