speiger.src.collections.shorts.misc.pairs

Interface ShortBooleanPair

All Known Implementing Classes:

ShortBooleanImmutablePair, ShortBooleanMutablePair

public interface ShortBooleanPair

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

Field Summary

Fields

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

Method Summary

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

Field Detail

EMPTY

static final ShortBooleanPair EMPTY

Empty Reference for Immutable Pairs

Method Detail

of

static ShortBooleanPair of()

Returns:

empty Immutable Pair

ofKey

static ShortBooleanPair ofKey(short key)

Parameters:

key - the key that should be in the pair

Returns:

Immutable Pair of Key

ofValue

static ShortBooleanPair ofValue(boolean value)

Parameters:

value - the value that should be in the pair

Returns:

Immutable Pair of Value

of

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

Parameters:

pair - the Pair that should be immutably copied

Returns:

a Immutable Copy of the Provided Pair

mutable

static ShortBooleanPair mutable()

Returns:

empty Mutable Pair

mutableKey

static ShortBooleanPair mutableKey(short key)

Parameters:

key - the key that should be in the pair

Returns:

Mutable Pair of key

mutableValue

static ShortBooleanPair mutableValue(boolean value)

Parameters:

value - the value that should be in the pair

Returns:

Mutable Pair of value

mutable

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

Parameters:

pair - the Pair that should be copied

Returns:

a Mutable Copy of the Provided Pair

setShortKey

ShortBooleanPair 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

setBooleanValue

ShortBooleanPair setBooleanValue(boolean 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.

getBooleanValue

boolean getBooleanValue()

Returns:

the Value of the Pair

set

ShortBooleanPair set(short key,
                     boolean 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

ShortBooleanPair shallowCopy()

Clones the Pair if it is mutable.

Returns:

a New Mutable Instance if it is mutable