speiger.src.collections.booleans.misc.pairs

Interface BooleanLongPair

All Known Implementing Classes:

BooleanLongImmutablePair, BooleanLongMutablePair

public interface BooleanLongPair

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
boolean	getBooleanKey()
long	getLongValue()
static BooleanLongPair	mutable()
static BooleanLongPair	mutable(boolean key, long value)
static BooleanLongPair	mutable(BooleanLongPair pair)
static BooleanLongPair	mutableKey(boolean key)
static BooleanLongPair	mutableValue(long value)
static BooleanLongPair	of()
static BooleanLongPair	of(boolean key, long value)
static BooleanLongPair	of(BooleanLongPair pair)
static BooleanLongPair	ofKey(boolean key)
static BooleanLongPair	ofValue(long value)
BooleanLongPair	set(boolean key, long value) Sets key and value of the Pair
BooleanLongPair	setBooleanKey(boolean key) Sets the Key of the Pair.
BooleanLongPair	setLongValue(long value) Sets the Value of the Pair.
BooleanLongPair	shallowCopy() Clones the Pair if it is mutable.

Field Detail

EMPTY

static final BooleanLongPair EMPTY

Empty Reference for Immutable Pairs

Method Detail

of

static BooleanLongPair of()

Returns:

empty Immutable Pair

ofKey

static BooleanLongPair ofKey(boolean key)

Parameters:

key - the key that should be in the pair

Returns:

Immutable Pair of Key

ofValue

static BooleanLongPair ofValue(long value)

Parameters:

value - the value that should be in the pair

Returns:

Immutable Pair of Value

of

static BooleanLongPair of(boolean key,
                          long 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 BooleanLongPair of(BooleanLongPair pair)

Parameters:

pair - the Pair that should be immutably copied

Returns:

a Immutable Copy of the Provided Pair

mutable

static BooleanLongPair mutable()

Returns:

empty Mutable Pair

mutableKey

static BooleanLongPair mutableKey(boolean key)

Parameters:

key - the key that should be in the pair

Returns:

Mutable Pair of key

mutableValue

static BooleanLongPair mutableValue(long value)

Parameters:

value - the value that should be in the pair

Returns:

Mutable Pair of value

mutable

static BooleanLongPair mutable(boolean key,
                               long 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 BooleanLongPair mutable(BooleanLongPair pair)

Parameters:

pair - the Pair that should be copied

Returns:

a Mutable Copy of the Provided Pair

setBooleanKey

BooleanLongPair setBooleanKey(boolean 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.

getBooleanKey

boolean getBooleanKey()

Returns:

the Key of the Pair

setLongValue

BooleanLongPair setLongValue(long 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.

getLongValue

long getLongValue()

Returns:

the Value of the Pair

set

BooleanLongPair set(boolean key,
                    long 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

BooleanLongPair shallowCopy()

Clones the Pair if it is mutable.

Returns:

a New Mutable Instance if it is mutable