speiger.src.collections.doubles.misc.pairs

Interface DoubleShortPair

All Known Implementing Classes:

DoubleShortImmutablePair, DoubleShortMutablePair

public interface DoubleShortPair

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

Field Summary

Fields

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

Method Summary

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

Field Detail

EMPTY

static final DoubleShortPair EMPTY

Empty Reference for Immutable Pairs

Method Detail

of

static DoubleShortPair of()

Returns:

empty Immutable Pair

ofKey

static DoubleShortPair ofKey(double key)

Parameters:

key - the key that should be in the pair

Returns:

Immutable Pair of Key

ofValue

static DoubleShortPair ofValue(short value)

Parameters:

value - the value that should be in the pair

Returns:

Immutable Pair of Value

of

static DoubleShortPair of(double 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 DoubleShortPair of(DoubleShortPair pair)

Parameters:

pair - the Pair that should be immutably copied

Returns:

a Immutable Copy of the Provided Pair

mutable

static DoubleShortPair mutable()

Returns:

empty Mutable Pair

mutableKey

static DoubleShortPair mutableKey(double key)

Parameters:

key - the key that should be in the pair

Returns:

Mutable Pair of key

mutableValue

static DoubleShortPair mutableValue(short value)

Parameters:

value - the value that should be in the pair

Returns:

Mutable Pair of value

mutable

static DoubleShortPair mutable(double 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 DoubleShortPair mutable(DoubleShortPair pair)

Parameters:

pair - the Pair that should be copied

Returns:

a Mutable Copy of the Provided Pair

setDoubleKey

DoubleShortPair setDoubleKey(double 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.

getDoubleKey

double getDoubleKey()

Returns:

the Key of the Pair

setShortValue

DoubleShortPair 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

DoubleShortPair set(double 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

DoubleShortPair shallowCopy()

Clones the Pair if it is mutable.

Returns:

a New Mutable Instance if it is mutable