speiger.src.collections.bytes.misc.pairs

Interface ByteBooleanPair

All Known Implementing Classes:

ByteBooleanImmutablePair, ByteBooleanMutablePair

public interface ByteBooleanPair

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

Field Summary

Fields

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

Method Summary

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

Field Detail

EMPTY

static final ByteBooleanPair EMPTY

Empty Reference for Immutable Pairs

Method Detail

of

static ByteBooleanPair of()

Returns:

empty Immutable Pair

ofKey

static ByteBooleanPair ofKey(byte key)

Parameters:

key - the key that should be in the pair

Returns:

Immutable Pair of Key

ofValue

static ByteBooleanPair ofValue(boolean value)

Parameters:

value - the value that should be in the pair

Returns:

Immutable Pair of Value

of

static ByteBooleanPair of(byte 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 ByteBooleanPair of(ByteBooleanPair pair)

Parameters:

pair - the Pair that should be immutably copied

Returns:

a Immutable Copy of the Provided Pair

mutable

static ByteBooleanPair mutable()

Returns:

empty Mutable Pair

mutableKey

static ByteBooleanPair mutableKey(byte key)

Parameters:

key - the key that should be in the pair

Returns:

Mutable Pair of key

mutableValue

static ByteBooleanPair mutableValue(boolean value)

Parameters:

value - the value that should be in the pair

Returns:

Mutable Pair of value

mutable

static ByteBooleanPair mutable(byte 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 ByteBooleanPair mutable(ByteBooleanPair pair)

Parameters:

pair - the Pair that should be copied

Returns:

a Mutable Copy of the Provided Pair

setByteKey

ByteBooleanPair setByteKey(byte 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.

getByteKey

byte getByteKey()

Returns:

the Key of the Pair

setBooleanValue

ByteBooleanPair 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

ByteBooleanPair set(byte 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

ByteBooleanPair shallowCopy()

Clones the Pair if it is mutable.

Returns:

a New Mutable Instance if it is mutable