speiger.src.collections.ints.misc.pairs

Interface IntShortPair

All Known Implementing Classes:

IntShortImmutablePair, IntShortMutablePair

public interface IntShortPair

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

Field Summary

Fields

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

Method Summary

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

Field Detail

EMPTY

static final IntShortPair EMPTY

Empty Reference for Immutable Pairs

Method Detail

of

static IntShortPair of()

Returns:

empty Immutable Pair

ofKey

static IntShortPair ofKey(int key)

Parameters:

key - the key that should be in the pair

Returns:

Immutable Pair of Key

ofValue

static IntShortPair ofValue(short value)

Parameters:

value - the value that should be in the pair

Returns:

Immutable Pair of Value

of

static IntShortPair of(int 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 IntShortPair of(IntShortPair pair)

Parameters:

pair - the Pair that should be immutably copied

Returns:

a Immutable Copy of the Provided Pair

mutable

static IntShortPair mutable()

Returns:

empty Mutable Pair

mutableKey

static IntShortPair mutableKey(int key)

Parameters:

key - the key that should be in the pair

Returns:

Mutable Pair of key

mutableValue

static IntShortPair mutableValue(short value)

Parameters:

value - the value that should be in the pair

Returns:

Mutable Pair of value

mutable

static IntShortPair mutable(int 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 IntShortPair mutable(IntShortPair pair)

Parameters:

pair - the Pair that should be copied

Returns:

a Mutable Copy of the Provided Pair

setIntKey

IntShortPair setIntKey(int 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.

getIntKey

int getIntKey()

Returns:

the Key of the Pair

setShortValue

IntShortPair 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

IntShortPair set(int 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

IntShortPair shallowCopy()

Clones the Pair if it is mutable.

Returns:

a New Mutable Instance if it is mutable