speiger.src.collections.booleans.misc.pairs

Interface BooleanShortPair

All Known Implementing Classes:

BooleanShortImmutablePair, BooleanShortMutablePair

public interface BooleanShortPair

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

Field Summary

Fields

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

Method Summary

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

Field Detail

EMPTY

static final BooleanShortPair EMPTY

Empty Reference for Immutable Pairs

Method Detail

of

static BooleanShortPair of()

Returns:

empty Immutable Pair

ofKey

static BooleanShortPair ofKey(boolean key)

Parameters:

key - the key that should be in the pair

Returns:

Immutable Pair of Key

ofValue

static BooleanShortPair ofValue(short value)

Parameters:

value - the value that should be in the pair

Returns:

Immutable Pair of Value

of

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

Parameters:

pair - the Pair that should be immutably copied

Returns:

a Immutable Copy of the Provided Pair

mutable

static BooleanShortPair mutable()

Returns:

empty Mutable Pair

mutableKey

static BooleanShortPair mutableKey(boolean key)

Parameters:

key - the key that should be in the pair

Returns:

Mutable Pair of key

mutableValue

static BooleanShortPair mutableValue(short value)

Parameters:

value - the value that should be in the pair

Returns:

Mutable Pair of value

mutable

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

Parameters:

pair - the Pair that should be copied

Returns:

a Mutable Copy of the Provided Pair

setBooleanKey

BooleanShortPair 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

setShortValue

BooleanShortPair 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

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

BooleanShortPair shallowCopy()

Clones the Pair if it is mutable.

Returns:

a New Mutable Instance if it is mutable