speiger.src.collections.longs.misc.pairs

Interface LongShortPair

All Known Implementing Classes:

LongShortImmutablePair, LongShortMutablePair

public interface LongShortPair

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

Field Summary

Fields

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

Method Summary

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

Field Detail

EMPTY

static final LongShortPair EMPTY

Empty Reference for Immutable Pairs

Method Detail

of

static LongShortPair of()

Returns:

empty Immutable Pair

ofKey

static LongShortPair ofKey(long key)

Parameters:

key - the key that should be in the pair

Returns:

Immutable Pair of Key

ofValue

static LongShortPair ofValue(short value)

Parameters:

value - the value that should be in the pair

Returns:

Immutable Pair of Value

of

static LongShortPair of(long 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 LongShortPair of(LongShortPair pair)

Parameters:

pair - the Pair that should be immutably copied

Returns:

a Immutable Copy of the Provided Pair

mutable

static LongShortPair mutable()

Returns:

empty Mutable Pair

mutableKey

static LongShortPair mutableKey(long key)

Parameters:

key - the key that should be in the pair

Returns:

Mutable Pair of key

mutableValue

static LongShortPair mutableValue(short value)

Parameters:

value - the value that should be in the pair

Returns:

Mutable Pair of value

mutable

static LongShortPair mutable(long 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 LongShortPair mutable(LongShortPair pair)

Parameters:

pair - the Pair that should be copied

Returns:

a Mutable Copy of the Provided Pair

setLongKey

LongShortPair setLongKey(long 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.

getLongKey

long getLongKey()

Returns:

the Key of the Pair

setShortValue

LongShortPair 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

LongShortPair set(long 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

LongShortPair shallowCopy()

Clones the Pair if it is mutable.

Returns:

a New Mutable Instance if it is mutable