speiger.src.collections.shorts.misc.pairs

Interface ShortShortPair

All Known Implementing Classes:

ShortShortImmutablePair, ShortShortMutablePair

public interface ShortShortPair

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

Field Summary

Fields

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

Method Summary

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

Field Detail

EMPTY

static final ShortShortPair EMPTY

Empty Reference for Immutable Pairs

Method Detail

of

static ShortShortPair of()

Returns:

empty Immutable Pair

ofKey

static ShortShortPair ofKey(short key)

Parameters:

key - the key that should be in the pair

Returns:

Immutable Pair of Key

ofValue

static ShortShortPair ofValue(short value)

Parameters:

value - the value that should be in the pair

Returns:

Immutable Pair of Value

of

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

Parameters:

pair - the Pair that should be immutably copied

Returns:

a Immutable Copy of the Provided Pair

mutable

static ShortShortPair mutable()

Returns:

empty Mutable Pair

mutableKey

static ShortShortPair mutableKey(short key)

Parameters:

key - the key that should be in the pair

Returns:

Mutable Pair of key

mutableValue

static ShortShortPair mutableValue(short value)

Parameters:

value - the value that should be in the pair

Returns:

Mutable Pair of value

mutable

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

Parameters:

pair - the Pair that should be copied

Returns:

a Mutable Copy of the Provided Pair

setShortKey

ShortShortPair 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

setShortValue

ShortShortPair 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

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

ShortShortPair shallowCopy()

Clones the Pair if it is mutable.

Returns:

a New Mutable Instance if it is mutable