speiger.src.collections.floats.misc.pairs

Interface FloatIntPair

All Known Implementing Classes:

FloatIntImmutablePair, FloatIntMutablePair

public interface FloatIntPair

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

Field Summary

Fields

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

Method Summary

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

Field Detail

EMPTY

static final FloatIntPair EMPTY

Empty Reference for Immutable Pairs

Method Detail

of

static FloatIntPair of()

Returns:

empty Immutable Pair

ofKey

static FloatIntPair ofKey(float key)

Parameters:

key - the key that should be in the pair

Returns:

Immutable Pair of Key

ofValue

static FloatIntPair ofValue(int value)

Parameters:

value - the value that should be in the pair

Returns:

Immutable Pair of Value

of

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

Parameters:

pair - the Pair that should be immutably copied

Returns:

a Immutable Copy of the Provided Pair

mutable

static FloatIntPair mutable()

Returns:

empty Mutable Pair

mutableKey

static FloatIntPair mutableKey(float key)

Parameters:

key - the key that should be in the pair

Returns:

Mutable Pair of key

mutableValue

static FloatIntPair mutableValue(int value)

Parameters:

value - the value that should be in the pair

Returns:

Mutable Pair of value

mutable

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

Parameters:

pair - the Pair that should be copied

Returns:

a Mutable Copy of the Provided Pair

setFloatKey

FloatIntPair 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

setIntValue

FloatIntPair setIntValue(int 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.

getIntValue

int getIntValue()

Returns:

the Value of the Pair

set

FloatIntPair set(float key,
                 int 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

FloatIntPair shallowCopy()

Clones the Pair if it is mutable.

Returns:

a New Mutable Instance if it is mutable