speiger.src.collections.bytes.misc.pairs

Interface ByteBytePair

All Known Implementing Classes:

ByteByteImmutablePair, ByteByteMutablePair

public interface ByteBytePair

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

Field Summary

Fields

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

Method Summary

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

Field Detail

EMPTY

static final ByteBytePair EMPTY

Empty Reference for Immutable Pairs

Method Detail

of

static ByteBytePair of()

Returns:

empty Immutable Pair

ofKey

static ByteBytePair ofKey(byte key)

Parameters:

key - the key that should be in the pair

Returns:

Immutable Pair of Key

ofValue

static ByteBytePair ofValue(byte value)

Parameters:

value - the value that should be in the pair

Returns:

Immutable Pair of Value

of

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

Parameters:

pair - the Pair that should be immutably copied

Returns:

a Immutable Copy of the Provided Pair

mutable

static ByteBytePair mutable()

Returns:

empty Mutable Pair

mutableKey

static ByteBytePair mutableKey(byte key)

Parameters:

key - the key that should be in the pair

Returns:

Mutable Pair of key

mutableValue

static ByteBytePair mutableValue(byte value)

Parameters:

value - the value that should be in the pair

Returns:

Mutable Pair of value

mutable

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

Parameters:

pair - the Pair that should be copied

Returns:

a Mutable Copy of the Provided Pair

setByteKey

ByteBytePair 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

setByteValue

ByteBytePair 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

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

ByteBytePair shallowCopy()

Clones the Pair if it is mutable.

Returns:

a New Mutable Instance if it is mutable