speiger.src.collections.bytes.misc.pairs

Interface ByteCharPair

All Known Implementing Classes:

ByteCharImmutablePair, ByteCharMutablePair

public interface ByteCharPair

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

Field Summary

Fields

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

Method Summary

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

Field Detail

EMPTY

static final ByteCharPair EMPTY

Empty Reference for Immutable Pairs

Method Detail

of

static ByteCharPair of()

Returns:

empty Immutable Pair

ofKey

static ByteCharPair ofKey(byte key)

Parameters:

key - the key that should be in the pair

Returns:

Immutable Pair of Key

ofValue

static ByteCharPair ofValue(char value)

Parameters:

value - the value that should be in the pair

Returns:

Immutable Pair of Value

of

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

Parameters:

pair - the Pair that should be immutably copied

Returns:

a Immutable Copy of the Provided Pair

mutable

static ByteCharPair mutable()

Returns:

empty Mutable Pair

mutableKey

static ByteCharPair mutableKey(byte key)

Parameters:

key - the key that should be in the pair

Returns:

Mutable Pair of key

mutableValue

static ByteCharPair mutableValue(char value)

Parameters:

value - the value that should be in the pair

Returns:

Mutable Pair of value

mutable

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

Parameters:

pair - the Pair that should be copied

Returns:

a Mutable Copy of the Provided Pair

setByteKey

ByteCharPair 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

setCharValue

ByteCharPair setCharValue(char 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.

getCharValue

char getCharValue()

Returns:

the Value of the Pair

set

ByteCharPair set(byte key,
                 char 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

ByteCharPair shallowCopy()

Clones the Pair if it is mutable.

Returns:

a New Mutable Instance if it is mutable