ByteDoublePair (Primitive-Collections 0.7.0 API)

All Known Implementing Classes:

ByteDoubleImmutablePair, ByteDoubleMutablePair
```
public interface ByteDoublePair
```
Key Value Pair Interface that allows to reduce boxing/unboxing.

Field Summary

Fields
Modifier and Type Field and Description

static ByteDoublePair EMPTY
Empty Reference for Immutable Pairs

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

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`byte`	`getByteKey()`
`double`	`getDoubleValue()`
`static ByteDoublePair`	`mutable()`
`static ByteDoublePair`	`mutable(byte key, double value)`
`static ByteDoublePair`	`mutable(ByteDoublePair pair)`
`static ByteDoublePair`	`mutableKey(byte key)`
`static ByteDoublePair`	`mutableValue(double value)`
`static ByteDoublePair`	`of()`
`static ByteDoublePair`	`of(byte key, double value)`
`static ByteDoublePair`	`of(ByteDoublePair pair)`
`static ByteDoublePair`	`ofKey(byte key)`
`static ByteDoublePair`	`ofValue(double value)`
`ByteDoublePair`	`set(byte key, double value)` Sets key and value of the Pair
`ByteDoublePair`	`setByteKey(byte key)` Sets the Key of the Pair.
`ByteDoublePair`	`setDoubleValue(double value)` Sets the Value of the Pair.
`ByteDoublePair`	`shallowCopy()` Clones the Pair if it is mutable.

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

Interface ByteDoublePair

Field Summary

Method Summary

Field Detail

EMPTY

Method Detail

of

ofKey

ofValue

of

of

mutable

mutableKey

mutableValue

mutable

mutable

setByteKey

getByteKey

setDoubleValue

getDoubleValue

set

shallowCopy