speiger.src.collections.booleans.misc.pairs

Interface BooleanFloatPair

All Known Implementing Classes:

BooleanFloatImmutablePair, BooleanFloatMutablePair

public interface BooleanFloatPair

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

Field Summary

Fields

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

Method Summary

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

Field Detail

EMPTY

static final BooleanFloatPair EMPTY

Empty Reference for Immutable Pairs

Method Detail

of

static BooleanFloatPair of()

Returns:

empty Immutable Pair

ofKey

static BooleanFloatPair ofKey(boolean key)

Parameters:

key - the key that should be in the pair

Returns:

Immutable Pair of Key

ofValue

static BooleanFloatPair ofValue(float value)

Parameters:

value - the value that should be in the pair

Returns:

Immutable Pair of Value

of

static BooleanFloatPair of(boolean 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 BooleanFloatPair of(BooleanFloatPair pair)

Parameters:

pair - the Pair that should be immutably copied

Returns:

a Immutable Copy of the Provided Pair

mutable

static BooleanFloatPair mutable()

Returns:

empty Mutable Pair

mutableKey

static BooleanFloatPair mutableKey(boolean key)

Parameters:

key - the key that should be in the pair

Returns:

Mutable Pair of key

mutableValue

static BooleanFloatPair mutableValue(float value)

Parameters:

value - the value that should be in the pair

Returns:

Mutable Pair of value

mutable

static BooleanFloatPair mutable(boolean 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 BooleanFloatPair mutable(BooleanFloatPair pair)

Parameters:

pair - the Pair that should be copied

Returns:

a Mutable Copy of the Provided Pair

setBooleanKey

BooleanFloatPair setBooleanKey(boolean 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.

getBooleanKey

boolean getBooleanKey()

Returns:

the Key of the Pair

setFloatValue

BooleanFloatPair 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

BooleanFloatPair set(boolean 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

BooleanFloatPair shallowCopy()

Clones the Pair if it is mutable.

Returns:

a New Mutable Instance if it is mutable