speiger.src.collections.booleans.misc.pairs

Interface BooleanBytePair

All Known Implementing Classes:

BooleanByteImmutablePair, BooleanByteMutablePair

public interface BooleanBytePair

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

Field Summary

Fields

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

Method Summary

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

Field Detail

EMPTY

static final BooleanBytePair EMPTY

Empty Reference for Immutable Pairs

Method Detail

of

static BooleanBytePair of()

Returns:

empty Immutable Pair

ofKey

static BooleanBytePair ofKey(boolean key)

Parameters:

key - the key that should be in the pair

Returns:

Immutable Pair of Key

ofValue

static BooleanBytePair ofValue(byte value)

Parameters:

value - the value that should be in the pair

Returns:

Immutable Pair of Value

of

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

Parameters:

pair - the Pair that should be immutably copied

Returns:

a Immutable Copy of the Provided Pair

mutable

static BooleanBytePair mutable()

Returns:

empty Mutable Pair

mutableKey

static BooleanBytePair mutableKey(boolean key)

Parameters:

key - the key that should be in the pair

Returns:

Mutable Pair of key

mutableValue

static BooleanBytePair mutableValue(byte value)

Parameters:

value - the value that should be in the pair

Returns:

Mutable Pair of value

mutable

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

Parameters:

pair - the Pair that should be copied

Returns:

a Mutable Copy of the Provided Pair

setBooleanKey

BooleanBytePair 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

setByteValue

BooleanBytePair setByteValue(byte 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.

getByteValue

byte getByteValue()

Returns:

the Value of the Pair

set

BooleanBytePair set(boolean key,
                    byte 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

BooleanBytePair shallowCopy()

Clones the Pair if it is mutable.

Returns:

a New Mutable Instance if it is mutable