BooleanDoublePair (Primitive-Collections 0.7.0 API)

All Known Implementing Classes:

BooleanDoubleImmutablePair, BooleanDoubleMutablePair
```
public interface BooleanDoublePair
```
Key Value Pair Interface that allows to reduce boxing/unboxing.

Field Summary

Fields
Modifier and Type Field and Description

static BooleanDoublePair EMPTY
Empty Reference for Immutable Pairs

Fields
Modifier and Type	Field and Description
`static BooleanDoublePair`	`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`	`getBooleanKey()`
`double`	`getDoubleValue()`
`static BooleanDoublePair`	`mutable()`
`static BooleanDoublePair`	`mutable(boolean key, double value)`
`static BooleanDoublePair`	`mutable(BooleanDoublePair pair)`
`static BooleanDoublePair`	`mutableKey(boolean key)`
`static BooleanDoublePair`	`mutableValue(double value)`
`static BooleanDoublePair`	`of()`
`static BooleanDoublePair`	`of(boolean key, double value)`
`static BooleanDoublePair`	`of(BooleanDoublePair pair)`
`static BooleanDoublePair`	`ofKey(boolean key)`
`static BooleanDoublePair`	`ofValue(double value)`
`BooleanDoublePair`	`set(boolean key, double value)` Sets key and value of the Pair
`BooleanDoublePair`	`setBooleanKey(boolean key)` Sets the Key of the Pair.
`BooleanDoublePair`	`setDoubleValue(double value)` Sets the Value of the Pair.
`BooleanDoublePair`	`shallowCopy()` Clones the Pair if it is mutable.

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

Interface BooleanDoublePair

Field Summary

Method Summary

Field Detail

EMPTY

Method Detail

of

ofKey

ofValue

of

of

mutable

mutableKey

mutableValue

mutable

mutable

setBooleanKey

getBooleanKey

setDoubleValue

getDoubleValue

set

shallowCopy