DoubleBooleanPair (Primitive-Collections 0.7.0 API)

All Known Implementing Classes:

DoubleBooleanImmutablePair, DoubleBooleanMutablePair
```
public interface DoubleBooleanPair
```
Key Value Pair Interface that allows to reduce boxing/unboxing.

Field Summary

Fields
Modifier and Type Field and Description

static DoubleBooleanPair EMPTY
Empty Reference for Immutable Pairs

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

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

Interface DoubleBooleanPair

Field Summary

Method Summary

Field Detail

EMPTY

Method Detail

of

ofKey

ofValue

of

of

mutable

mutableKey

mutableValue

mutable

mutable

setDoubleKey

getDoubleKey

setBooleanValue

getBooleanValue

set

shallowCopy