speiger.src.collections.ints.misc.pairs

Interface IntBooleanPair

All Known Implementing Classes:

IntBooleanImmutablePair, IntBooleanMutablePair

public interface IntBooleanPair

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

Field Summary

Fields

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

Method Summary

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

Field Detail

EMPTY

static final IntBooleanPair EMPTY

Empty Reference for Immutable Pairs

Method Detail

of

static IntBooleanPair of()

Returns:

empty Immutable Pair

ofKey

static IntBooleanPair ofKey(int key)

Parameters:

key - the key that should be in the pair

Returns:

Immutable Pair of Key

ofValue

static IntBooleanPair ofValue(boolean value)

Parameters:

value - the value that should be in the pair

Returns:

Immutable Pair of Value

of

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

Parameters:

pair - the Pair that should be immutably copied

Returns:

a Immutable Copy of the Provided Pair

mutable

static IntBooleanPair mutable()

Returns:

empty Mutable Pair

mutableKey

static IntBooleanPair mutableKey(int key)

Parameters:

key - the key that should be in the pair

Returns:

Mutable Pair of key

mutableValue

static IntBooleanPair mutableValue(boolean value)

Parameters:

value - the value that should be in the pair

Returns:

Mutable Pair of value

mutable

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

Parameters:

pair - the Pair that should be copied

Returns:

a Mutable Copy of the Provided Pair

setIntKey

IntBooleanPair 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

setBooleanValue

IntBooleanPair 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

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

IntBooleanPair shallowCopy()

Clones the Pair if it is mutable.

Returns:

a New Mutable Instance if it is mutable