speiger.src.collections.floats.misc.pairs

Interface FloatFloatPair

All Known Implementing Classes:

FloatFloatImmutablePair, FloatFloatMutablePair

public interface FloatFloatPair

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

Field Summary

Fields

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

Method Summary

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

Field Detail

EMPTY

static final FloatFloatPair EMPTY

Empty Reference for Immutable Pairs

Method Detail

of

static FloatFloatPair of()

Returns:

empty Immutable Pair

ofKey

static FloatFloatPair ofKey(float key)

Parameters:

key - the key that should be in the pair

Returns:

Immutable Pair of Key

ofValue

static FloatFloatPair ofValue(float value)

Parameters:

value - the value that should be in the pair

Returns:

Immutable Pair of Value

of

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

Parameters:

pair - the Pair that should be immutably copied

Returns:

a Immutable Copy of the Provided Pair

mutable

static FloatFloatPair mutable()

Returns:

empty Mutable Pair

mutableKey

static FloatFloatPair mutableKey(float key)

Parameters:

key - the key that should be in the pair

Returns:

Mutable Pair of key

mutableValue

static FloatFloatPair mutableValue(float value)

Parameters:

value - the value that should be in the pair

Returns:

Mutable Pair of value

mutable

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

Parameters:

pair - the Pair that should be copied

Returns:

a Mutable Copy of the Provided Pair

setFloatKey

FloatFloatPair 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

setFloatValue

FloatFloatPair 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

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

FloatFloatPair shallowCopy()

Clones the Pair if it is mutable.

Returns:

a New Mutable Instance if it is mutable