FloatBooleanPair (Primitive-Collections 0.7.0 API)

All Known Implementing Classes:

FloatBooleanImmutablePair, FloatBooleanMutablePair
```
public interface FloatBooleanPair
```
Key Value Pair Interface that allows to reduce boxing/unboxing.

Field Summary

Fields
Modifier and Type Field and Description

static FloatBooleanPair EMPTY
Empty Reference for Immutable Pairs

Fields
Modifier and Type	Field and Description
`static FloatBooleanPair`	`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()`
`float`	`getFloatKey()`
`static FloatBooleanPair`	`mutable()`
`static FloatBooleanPair`	`mutable(float key, boolean value)`
`static FloatBooleanPair`	`mutable(FloatBooleanPair pair)`
`static FloatBooleanPair`	`mutableKey(float key)`
`static FloatBooleanPair`	`mutableValue(boolean value)`
`static FloatBooleanPair`	`of()`
`static FloatBooleanPair`	`of(float key, boolean value)`
`static FloatBooleanPair`	`of(FloatBooleanPair pair)`
`static FloatBooleanPair`	`ofKey(float key)`
`static FloatBooleanPair`	`ofValue(boolean value)`
`FloatBooleanPair`	`set(float key, boolean value)` Sets key and value of the Pair
`FloatBooleanPair`	`setBooleanValue(boolean value)` Sets the Value of the Pair.
`FloatBooleanPair`	`setFloatKey(float key)` Sets the Key of the Pair.
`FloatBooleanPair`	`shallowCopy()` Clones the Pair if it is mutable.

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

Interface FloatBooleanPair

Field Summary

Method Summary

Field Detail

EMPTY

Method Detail

of

ofKey

ofValue

of

of

mutable

mutableKey

mutableValue

mutable

mutable

setFloatKey

getFloatKey

setBooleanValue

getBooleanValue

set

shallowCopy