speiger.src.collections.chars.misc.pairs

Interface CharBytePair

All Known Implementing Classes:

CharByteImmutablePair, CharByteMutablePair

public interface CharBytePair

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

Field Summary

Fields

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

Method Summary

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

Field Detail

EMPTY

static final CharBytePair EMPTY

Empty Reference for Immutable Pairs

Method Detail

of

static CharBytePair of()

Returns:

empty Immutable Pair

ofKey

static CharBytePair ofKey(char key)

Parameters:

key - the key that should be in the pair

Returns:

Immutable Pair of Key

ofValue

static CharBytePair ofValue(byte value)

Parameters:

value - the value that should be in the pair

Returns:

Immutable Pair of Value

of

static CharBytePair of(char 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 CharBytePair of(CharBytePair pair)

Parameters:

pair - the Pair that should be immutably copied

Returns:

a Immutable Copy of the Provided Pair

mutable

static CharBytePair mutable()

Returns:

empty Mutable Pair

mutableKey

static CharBytePair mutableKey(char key)

Parameters:

key - the key that should be in the pair

Returns:

Mutable Pair of key

mutableValue

static CharBytePair mutableValue(byte value)

Parameters:

value - the value that should be in the pair

Returns:

Mutable Pair of value

mutable

static CharBytePair mutable(char 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 CharBytePair mutable(CharBytePair pair)

Parameters:

pair - the Pair that should be copied

Returns:

a Mutable Copy of the Provided Pair

setCharKey

CharBytePair setCharKey(char 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.

getCharKey

char getCharKey()

Returns:

the Key of the Pair

setByteValue

CharBytePair 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

CharBytePair set(char 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

CharBytePair shallowCopy()

Clones the Pair if it is mutable.

Returns:

a New Mutable Instance if it is mutable