speiger.src.collections.floats.misc.pairs

Interface FloatDoublePair

All Known Implementing Classes:

FloatDoubleImmutablePair, FloatDoubleMutablePair

public interface FloatDoublePair

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

Field Summary

Fields

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

Method Summary

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

Field Detail

EMPTY

static final FloatDoublePair EMPTY

Empty Reference for Immutable Pairs

Method Detail

of

static FloatDoublePair of()

Returns:

empty Immutable Pair

ofKey

static FloatDoublePair ofKey(float key)

Parameters:

key - the key that should be in the pair

Returns:

Immutable Pair of Key

ofValue

static FloatDoublePair ofValue(double value)

Parameters:

value - the value that should be in the pair

Returns:

Immutable Pair of Value

of

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

Parameters:

pair - the Pair that should be immutably copied

Returns:

a Immutable Copy of the Provided Pair

mutable

static FloatDoublePair mutable()

Returns:

empty Mutable Pair

mutableKey

static FloatDoublePair mutableKey(float key)

Parameters:

key - the key that should be in the pair

Returns:

Mutable Pair of key

mutableValue

static FloatDoublePair mutableValue(double value)

Parameters:

value - the value that should be in the pair

Returns:

Mutable Pair of value

mutable

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

Parameters:

pair - the Pair that should be copied

Returns:

a Mutable Copy of the Provided Pair

setFloatKey

FloatDoublePair 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

setDoubleValue

FloatDoublePair setDoubleValue(double 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.

getDoubleValue

double getDoubleValue()

Returns:

the Value of the Pair

set

FloatDoublePair set(float key,
                    double 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

FloatDoublePair shallowCopy()

Clones the Pair if it is mutable.

Returns:

a New Mutable Instance if it is mutable