speiger.src.collections.shorts.misc.pairs

Interface ShortFloatPair

All Known Implementing Classes:

ShortFloatImmutablePair, ShortFloatMutablePair

public interface ShortFloatPair

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

Field Summary

Fields

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

Method Summary

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

Field Detail

EMPTY

static final ShortFloatPair EMPTY

Empty Reference for Immutable Pairs

Method Detail

of

static ShortFloatPair of()

Returns:

empty Immutable Pair

ofKey

static ShortFloatPair ofKey(short key)

Parameters:

key - the key that should be in the pair

Returns:

Immutable Pair of Key

ofValue

static ShortFloatPair ofValue(float value)

Parameters:

value - the value that should be in the pair

Returns:

Immutable Pair of Value

of

static ShortFloatPair of(short 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 ShortFloatPair of(ShortFloatPair pair)

Parameters:

pair - the Pair that should be immutably copied

Returns:

a Immutable Copy of the Provided Pair

mutable

static ShortFloatPair mutable()

Returns:

empty Mutable Pair

mutableKey

static ShortFloatPair mutableKey(short key)

Parameters:

key - the key that should be in the pair

Returns:

Mutable Pair of key

mutableValue

static ShortFloatPair mutableValue(float value)

Parameters:

value - the value that should be in the pair

Returns:

Mutable Pair of value

mutable

static ShortFloatPair mutable(short 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 ShortFloatPair mutable(ShortFloatPair pair)

Parameters:

pair - the Pair that should be copied

Returns:

a Mutable Copy of the Provided Pair

setShortKey

ShortFloatPair setShortKey(short 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.

getShortKey

short getShortKey()

Returns:

the Key of the Pair

setFloatValue

ShortFloatPair 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

ShortFloatPair set(short 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

ShortFloatPair shallowCopy()

Clones the Pair if it is mutable.

Returns:

a New Mutable Instance if it is mutable