speiger.src.collections.chars.misc.pairs

Interface CharLongPair

All Known Implementing Classes:

CharLongImmutablePair, CharLongMutablePair

public interface CharLongPair

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

Field Summary

Fields

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

Method Summary

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

Field Detail

EMPTY

static final CharLongPair EMPTY

Empty Reference for Immutable Pairs

Method Detail

of

static CharLongPair of()

Returns:

empty Immutable Pair

ofKey

static CharLongPair ofKey(char key)

Parameters:

key - the key that should be in the pair

Returns:

Immutable Pair of Key

ofValue

static CharLongPair ofValue(long value)

Parameters:

value - the value that should be in the pair

Returns:

Immutable Pair of Value

of

static CharLongPair of(char key,
                       long 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 CharLongPair of(CharLongPair pair)

Parameters:

pair - the Pair that should be immutably copied

Returns:

a Immutable Copy of the Provided Pair

mutable

static CharLongPair mutable()

Returns:

empty Mutable Pair

mutableKey

static CharLongPair mutableKey(char key)

Parameters:

key - the key that should be in the pair

Returns:

Mutable Pair of key

mutableValue

static CharLongPair mutableValue(long value)

Parameters:

value - the value that should be in the pair

Returns:

Mutable Pair of value

mutable

static CharLongPair mutable(char key,
                            long 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 CharLongPair mutable(CharLongPair pair)

Parameters:

pair - the Pair that should be copied

Returns:

a Mutable Copy of the Provided Pair

setCharKey

CharLongPair 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

setLongValue

CharLongPair setLongValue(long 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.

getLongValue

long getLongValue()

Returns:

the Value of the Pair

set

CharLongPair set(char key,
                 long 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

CharLongPair shallowCopy()

Clones the Pair if it is mutable.

Returns:

a New Mutable Instance if it is mutable