CharBooleanPair (Primitive-Collections 0.7.0 API)

All Known Implementing Classes:

CharBooleanImmutablePair, CharBooleanMutablePair
```
public interface CharBooleanPair
```
Key Value Pair Interface that allows to reduce boxing/unboxing.

Field Summary

Fields
Modifier and Type Field and Description

static CharBooleanPair EMPTY
Empty Reference for Immutable Pairs

Fields
Modifier and Type	Field and Description
`static CharBooleanPair`	`EMPTY` Empty Reference for Immutable Pairs

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`boolean`	`getBooleanValue()`
`char`	`getCharKey()`
`static CharBooleanPair`	`mutable()`
`static CharBooleanPair`	`mutable(char key, boolean value)`
`static CharBooleanPair`	`mutable(CharBooleanPair pair)`
`static CharBooleanPair`	`mutableKey(char key)`
`static CharBooleanPair`	`mutableValue(boolean value)`
`static CharBooleanPair`	`of()`
`static CharBooleanPair`	`of(char key, boolean value)`
`static CharBooleanPair`	`of(CharBooleanPair pair)`
`static CharBooleanPair`	`ofKey(char key)`
`static CharBooleanPair`	`ofValue(boolean value)`
`CharBooleanPair`	`set(char key, boolean value)` Sets key and value of the Pair
`CharBooleanPair`	`setBooleanValue(boolean value)` Sets the Value of the Pair.
`CharBooleanPair`	`setCharKey(char key)` Sets the Key of the Pair.
`CharBooleanPair`	`shallowCopy()` Clones the Pair if it is mutable.

- Field Detail
  - EMPTY
```
static final CharBooleanPair EMPTY
```
    Empty Reference for Immutable Pairs
- Method Detail
  - of
```
static CharBooleanPair of()
```
    Returns:
    
    empty Immutable Pair
  - ofKey
```
static CharBooleanPair ofKey(char key)
```
    Parameters:
    
    key - the key that should be in the pair
    
    Returns:
    
    Immutable Pair of Key
  - ofValue
```
static CharBooleanPair ofValue(boolean value)
```
    Parameters:
    
    value - the value that should be in the pair
    
    Returns:
    
    Immutable Pair of Value
  - of
```
static CharBooleanPair of(char 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 CharBooleanPair of(CharBooleanPair pair)
```
    Parameters:
    
    pair - the Pair that should be immutably copied
    
    Returns:
    
    a Immutable Copy of the Provided Pair
  - mutable
```
static CharBooleanPair mutable()
```
    Returns:
    
    empty Mutable Pair
  - mutableKey
```
static CharBooleanPair mutableKey(char key)
```
    Parameters:
    
    key - the key that should be in the pair
    
    Returns:
    
    Mutable Pair of key
  - mutableValue
```
static CharBooleanPair mutableValue(boolean value)
```
    Parameters:
    
    value - the value that should be in the pair
    
    Returns:
    
    Mutable Pair of value
  - mutable
```
static CharBooleanPair mutable(char 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 CharBooleanPair mutable(CharBooleanPair pair)
```
    Parameters:
    
    pair - the Pair that should be copied
    
    Returns:
    
    a Mutable Copy of the Provided Pair
  - setCharKey
```
CharBooleanPair setCharKey(char 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.
  - getCharKey
```
char getCharKey()
```
    Returns:
    
    the Key of the Pair
  - setBooleanValue
```
CharBooleanPair 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
```
CharBooleanPair set(char 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
```
CharBooleanPair shallowCopy()
```
    Clones the Pair if it is mutable.
    
    Returns:
    
    a New Mutable Instance if it is mutable

Interface CharBooleanPair

Field Summary

Method Summary

Field Detail

EMPTY

Method Detail

of

ofKey

ofValue

of

of

mutable

mutableKey

mutableValue

mutable

mutable

setCharKey

getCharKey

setBooleanValue

getBooleanValue

set

shallowCopy