speiger.src.collections.shorts.misc.pairs

Interface ShortDoublePair

All Known Implementing Classes:

ShortDoubleImmutablePair, ShortDoubleMutablePair

public interface ShortDoublePair

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

Field Summary

Fields

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

Method Summary

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

Field Detail

EMPTY

static final ShortDoublePair EMPTY

Empty Reference for Immutable Pairs

Method Detail

of

static ShortDoublePair of()

Returns:

empty Immutable Pair

ofKey

static ShortDoublePair ofKey(short key)

Parameters:

key - the key that should be in the pair

Returns:

Immutable Pair of Key

ofValue

static ShortDoublePair ofValue(double value)

Parameters:

value - the value that should be in the pair

Returns:

Immutable Pair of Value

of

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

Parameters:

pair - the Pair that should be immutably copied

Returns:

a Immutable Copy of the Provided Pair

mutable

static ShortDoublePair mutable()

Returns:

empty Mutable Pair

mutableKey

static ShortDoublePair mutableKey(short key)

Parameters:

key - the key that should be in the pair

Returns:

Mutable Pair of key

mutableValue

static ShortDoublePair mutableValue(double value)

Parameters:

value - the value that should be in the pair

Returns:

Mutable Pair of value

mutable

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

Parameters:

pair - the Pair that should be copied

Returns:

a Mutable Copy of the Provided Pair

setShortKey

ShortDoublePair 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

setDoubleValue

ShortDoublePair setDoubleValue(double 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.

getDoubleValue

double getDoubleValue()

Returns:

the Value of the Pair

set

ShortDoublePair set(short key,
                    double 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

ShortDoublePair shallowCopy()

Clones the Pair if it is mutable.

Returns:

a New Mutable Instance if it is mutable