speiger.src.collections.objects.misc.pairs

Interface ObjectFloatPair<T>

Type Parameters:

T - the keyType of elements maintained by this Collection

All Known Implementing Classes:

ObjectFloatImmutablePair, ObjectFloatMutablePair

public interface ObjectFloatPair<T>

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

Field Summary

Fields

Modifier and Type	Field and Description
static ObjectFloatPair<?>	EMPTY Empty Reference for Immutable Pairs

Method Summary

Modifier and Type	Method and Description
float	getFloatValue()
T	getKey()
static <T> ObjectFloatPair<T>	mutable()
static <T> ObjectFloatPair<T>	mutable(ObjectFloatPair<T> pair)
static <T> ObjectFloatPair<T>	mutable(T key, float value)
static <T> ObjectFloatPair<T>	mutableKey(T key)
static <T> ObjectFloatPair<T>	mutableValue(float value)
static <T> ObjectFloatPair<T>	of()
static <T> ObjectFloatPair<T>	of(ObjectFloatPair<T> pair)
static <T> ObjectFloatPair<T>	of(T key, float value)
static <T> ObjectFloatPair<T>	ofKey(T key)
static <T> ObjectFloatPair<T>	ofValue(float value)
ObjectFloatPair<T>	set(T key, float value) Sets key and value of the Pair
ObjectFloatPair<T>	setFloatValue(float value) Sets the Value of the Pair.
ObjectFloatPair<T>	setKey(T key) Sets the Key of the Pair.
ObjectFloatPair<T>	shallowCopy() Clones the Pair if it is mutable.

Field Detail

EMPTY

static final ObjectFloatPair<?> EMPTY

Empty Reference for Immutable Pairs

Method Detail

of

static <T> ObjectFloatPair<T> of()

Type Parameters:

T - the keyType of elements maintained by this Collection

Returns:

empty Immutable Pair

ofKey

static <T> ObjectFloatPair<T> ofKey(T key)

Type Parameters:

T - the keyType of elements maintained by this Collection

Parameters:

key - the key that should be in the pair

Returns:

Immutable Pair of Key

ofValue

static <T> ObjectFloatPair<T> ofValue(float value)

Type Parameters:

T - the keyType of elements maintained by this Collection

Parameters:

value - the value that should be in the pair

Returns:

Immutable Pair of Value

of

static <T> ObjectFloatPair<T> of(T key,
                                 float value)

Type Parameters:

T - the keyType of elements maintained by this Collection

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

Type Parameters:

T - the keyType of elements maintained by this Collection

Parameters:

pair - the Pair that should be immutably copied

Returns:

a Immutable Copy of the Provided Pair

mutable

static <T> ObjectFloatPair<T> mutable()

Type Parameters:

T - the keyType of elements maintained by this Collection

Returns:

empty Mutable Pair

mutableKey

static <T> ObjectFloatPair<T> mutableKey(T key)

Type Parameters:

T - the keyType of elements maintained by this Collection

Parameters:

key - the key that should be in the pair

Returns:

Mutable Pair of key

mutableValue

static <T> ObjectFloatPair<T> mutableValue(float value)

Type Parameters:

T - the keyType of elements maintained by this Collection

Parameters:

value - the value that should be in the pair

Returns:

Mutable Pair of value

mutable

static <T> ObjectFloatPair<T> mutable(T key,
                                      float value)

Type Parameters:

T - the keyType of elements maintained by this Collection

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

Type Parameters:

T - the keyType of elements maintained by this Collection

Parameters:

pair - the Pair that should be copied

Returns:

a Mutable Copy of the Provided Pair

setKey

ObjectFloatPair<T> setKey(T 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.

getKey

T getKey()

Returns:

the Key of the Pair

setFloatValue

ObjectFloatPair<T> 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

ObjectFloatPair<T> set(T 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

ObjectFloatPair<T> shallowCopy()

Clones the Pair if it is mutable.

Returns:

a New Mutable Instance if it is mutable