speiger.src.collections.shorts.misc.pairs

Interface ShortBytePair

All Known Implementing Classes:

ShortByteImmutablePair, ShortByteMutablePair

public interface ShortBytePair

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

Field Summary

Fields

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

Method Summary

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

Field Detail

EMPTY

static final ShortBytePair EMPTY

Empty Reference for Immutable Pairs

Method Detail

of

static ShortBytePair of()

Returns:

empty Immutable Pair

ofKey

static ShortBytePair ofKey(short key)

Parameters:

key - the key that should be in the pair

Returns:

Immutable Pair of Key

ofValue

static ShortBytePair ofValue(byte value)

Parameters:

value - the value that should be in the pair

Returns:

Immutable Pair of Value

of

static ShortBytePair of(short 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 ShortBytePair of(ShortBytePair pair)

Parameters:

pair - the Pair that should be immutably copied

Returns:

a Immutable Copy of the Provided Pair

mutable

static ShortBytePair mutable()

Returns:

empty Mutable Pair

mutableKey

static ShortBytePair mutableKey(short key)

Parameters:

key - the key that should be in the pair

Returns:

Mutable Pair of key

mutableValue

static ShortBytePair mutableValue(byte value)

Parameters:

value - the value that should be in the pair

Returns:

Mutable Pair of value

mutable

static ShortBytePair mutable(short 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 ShortBytePair mutable(ShortBytePair pair)

Parameters:

pair - the Pair that should be copied

Returns:

a Mutable Copy of the Provided Pair

setShortKey

ShortBytePair setShortKey(short 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.

getShortKey

short getShortKey()

Returns:

the Key of the Pair

setByteValue

ShortBytePair 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

ShortBytePair set(short 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

ShortBytePair shallowCopy()

Clones the Pair if it is mutable.

Returns:

a New Mutable Instance if it is mutable