speiger.src.collections.booleans.misc.pairs

Interface BooleanCharPair

All Known Implementing Classes:

BooleanCharImmutablePair, BooleanCharMutablePair

public interface BooleanCharPair

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

Field Summary

Fields

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

Method Summary

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

Field Detail

EMPTY

static final BooleanCharPair EMPTY

Empty Reference for Immutable Pairs

Method Detail

of

static BooleanCharPair of()

Returns:

empty Immutable Pair

ofKey

static BooleanCharPair ofKey(boolean key)

Parameters:

key - the key that should be in the pair

Returns:

Immutable Pair of Key

ofValue

static BooleanCharPair ofValue(char value)

Parameters:

value - the value that should be in the pair

Returns:

Immutable Pair of Value

of

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

Parameters:

pair - the Pair that should be immutably copied

Returns:

a Immutable Copy of the Provided Pair

mutable

static BooleanCharPair mutable()

Returns:

empty Mutable Pair

mutableKey

static BooleanCharPair mutableKey(boolean key)

Parameters:

key - the key that should be in the pair

Returns:

Mutable Pair of key

mutableValue

static BooleanCharPair mutableValue(char value)

Parameters:

value - the value that should be in the pair

Returns:

Mutable Pair of value

mutable

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

Parameters:

pair - the Pair that should be copied

Returns:

a Mutable Copy of the Provided Pair

setBooleanKey

BooleanCharPair 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

setCharValue

BooleanCharPair setCharValue(char 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.

getCharValue

char getCharValue()

Returns:

the Value of the Pair

set

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

BooleanCharPair shallowCopy()

Clones the Pair if it is mutable.

Returns:

a New Mutable Instance if it is mutable