speiger.src.collections.floats.misc.pairs

Interface FloatShortPair

All Known Implementing Classes:

FloatShortImmutablePair, FloatShortMutablePair

public interface FloatShortPair

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

Field Summary

Fields

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

Method Summary

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

Field Detail

EMPTY

static final FloatShortPair EMPTY

Empty Reference for Immutable Pairs

Method Detail

of

static FloatShortPair of()

Returns:

empty Immutable Pair

ofKey

static FloatShortPair ofKey(float key)

Parameters:

key - the key that should be in the pair

Returns:

Immutable Pair of Key

ofValue

static FloatShortPair ofValue(short value)

Parameters:

value - the value that should be in the pair

Returns:

Immutable Pair of Value

of

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

Parameters:

pair - the Pair that should be immutably copied

Returns:

a Immutable Copy of the Provided Pair

mutable

static FloatShortPair mutable()

Returns:

empty Mutable Pair

mutableKey

static FloatShortPair mutableKey(float key)

Parameters:

key - the key that should be in the pair

Returns:

Mutable Pair of key

mutableValue

static FloatShortPair mutableValue(short value)

Parameters:

value - the value that should be in the pair

Returns:

Mutable Pair of value

mutable

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

Parameters:

pair - the Pair that should be copied

Returns:

a Mutable Copy of the Provided Pair

setFloatKey

FloatShortPair 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

setShortValue

FloatShortPair setShortValue(short 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.

getShortValue

short getShortValue()

Returns:

the Value of the Pair

set

FloatShortPair set(float key,
                   short 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

FloatShortPair shallowCopy()

Clones the Pair if it is mutable.

Returns:

a New Mutable Instance if it is mutable