speiger.src.collections.doubles.misc.pairs

Interface DoubleBytePair

All Known Implementing Classes:

DoubleByteImmutablePair, DoubleByteMutablePair

public interface DoubleBytePair

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

Field Summary

Fields

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

Method Summary

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

Field Detail

EMPTY

static final DoubleBytePair EMPTY

Empty Reference for Immutable Pairs

Method Detail

of

static DoubleBytePair of()

Returns:

empty Immutable Pair

ofKey

static DoubleBytePair ofKey(double key)

Parameters:

key - the key that should be in the pair

Returns:

Immutable Pair of Key

ofValue

static DoubleBytePair ofValue(byte value)

Parameters:

value - the value that should be in the pair

Returns:

Immutable Pair of Value

of

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

Parameters:

pair - the Pair that should be immutably copied

Returns:

a Immutable Copy of the Provided Pair

mutable

static DoubleBytePair mutable()

Returns:

empty Mutable Pair

mutableKey

static DoubleBytePair mutableKey(double key)

Parameters:

key - the key that should be in the pair

Returns:

Mutable Pair of key

mutableValue

static DoubleBytePair mutableValue(byte value)

Parameters:

value - the value that should be in the pair

Returns:

Mutable Pair of value

mutable

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

Parameters:

pair - the Pair that should be copied

Returns:

a Mutable Copy of the Provided Pair

setDoubleKey

DoubleBytePair 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

setByteValue

DoubleBytePair setByteValue(byte 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.

getByteValue

byte getByteValue()

Returns:

the Value of the Pair

set

DoubleBytePair set(double key,
                   byte 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

DoubleBytePair shallowCopy()

Clones the Pair if it is mutable.

Returns:

a New Mutable Instance if it is mutable