speiger.src.collections.shorts.misc.pairs

Interface ShortCharPair

All Known Implementing Classes:

ShortCharImmutablePair, ShortCharMutablePair

public interface ShortCharPair

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

Field Summary

Fields

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

Method Summary

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

Field Detail

EMPTY

static final ShortCharPair EMPTY

Empty Reference for Immutable Pairs

Method Detail

of

static ShortCharPair of()

Returns:

empty Immutable Pair

ofKey

static ShortCharPair ofKey(short key)

Parameters:

key - the key that should be in the pair

Returns:

Immutable Pair of Key

ofValue

static ShortCharPair ofValue(char value)

Parameters:

value - the value that should be in the pair

Returns:

Immutable Pair of Value

of

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

Parameters:

pair - the Pair that should be immutably copied

Returns:

a Immutable Copy of the Provided Pair

mutable

static ShortCharPair mutable()

Returns:

empty Mutable Pair

mutableKey

static ShortCharPair mutableKey(short key)

Parameters:

key - the key that should be in the pair

Returns:

Mutable Pair of key

mutableValue

static ShortCharPair mutableValue(char value)

Parameters:

value - the value that should be in the pair

Returns:

Mutable Pair of value

mutable

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

Parameters:

pair - the Pair that should be copied

Returns:

a Mutable Copy of the Provided Pair

setShortKey

ShortCharPair 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

setCharValue

ShortCharPair 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

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

ShortCharPair shallowCopy()

Clones the Pair if it is mutable.

Returns:

a New Mutable Instance if it is mutable