speiger.src.collections.bytes.misc.pairs

Interface ByteShortPair

All Known Implementing Classes:

ByteShortImmutablePair, ByteShortMutablePair

public interface ByteShortPair

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

Field Summary

Fields

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

Method Summary

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

Field Detail

EMPTY

static final ByteShortPair EMPTY

Empty Reference for Immutable Pairs

Method Detail

of

static ByteShortPair of()

Returns:

empty Immutable Pair

ofKey

static ByteShortPair ofKey(byte key)

Parameters:

key - the key that should be in the pair

Returns:

Immutable Pair of Key

ofValue

static ByteShortPair ofValue(short value)

Parameters:

value - the value that should be in the pair

Returns:

Immutable Pair of Value

of

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

Parameters:

pair - the Pair that should be immutably copied

Returns:

a Immutable Copy of the Provided Pair

mutable

static ByteShortPair mutable()

Returns:

empty Mutable Pair

mutableKey

static ByteShortPair mutableKey(byte key)

Parameters:

key - the key that should be in the pair

Returns:

Mutable Pair of key

mutableValue

static ByteShortPair mutableValue(short value)

Parameters:

value - the value that should be in the pair

Returns:

Mutable Pair of value

mutable

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

Parameters:

pair - the Pair that should be copied

Returns:

a Mutable Copy of the Provided Pair

setByteKey

ByteShortPair 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

setShortValue

ByteShortPair setShortValue(short 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.

getShortValue

short getShortValue()

Returns:

the Value of the Pair

set

ByteShortPair set(byte key,
                  short 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

ByteShortPair shallowCopy()

Clones the Pair if it is mutable.

Returns:

a New Mutable Instance if it is mutable