speiger.src.collections.booleans.misc.pairs

Interface BooleanBooleanPair

All Known Implementing Classes:

BooleanBooleanImmutablePair, BooleanBooleanMutablePair

public interface BooleanBooleanPair

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

Field Summary

Fields

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

Method Summary

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

Field Detail

EMPTY

static final BooleanBooleanPair EMPTY

Empty Reference for Immutable Pairs

Method Detail

of

static BooleanBooleanPair of()

Returns:

empty Immutable Pair

ofKey

static BooleanBooleanPair ofKey(boolean key)

Parameters:

key - the key that should be in the pair

Returns:

Immutable Pair of Key

ofValue

static BooleanBooleanPair ofValue(boolean value)

Parameters:

value - the value that should be in the pair

Returns:

Immutable Pair of Value

of

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

Parameters:

pair - the Pair that should be immutably copied

Returns:

a Immutable Copy of the Provided Pair

mutable

static BooleanBooleanPair mutable()

Returns:

empty Mutable Pair

mutableKey

static BooleanBooleanPair mutableKey(boolean key)

Parameters:

key - the key that should be in the pair

Returns:

Mutable Pair of key

mutableValue

static BooleanBooleanPair mutableValue(boolean value)

Parameters:

value - the value that should be in the pair

Returns:

Mutable Pair of value

mutable

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

Parameters:

pair - the Pair that should be copied

Returns:

a Mutable Copy of the Provided Pair

setBooleanKey

BooleanBooleanPair 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

setBooleanValue

BooleanBooleanPair setBooleanValue(boolean 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.

getBooleanValue

boolean getBooleanValue()

Returns:

the Value of the Pair

set

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

BooleanBooleanPair shallowCopy()

Clones the Pair if it is mutable.

Returns:

a New Mutable Instance if it is mutable