FloatBytePair (Primitive-Collections 0.7.0 API)

All Known Implementing Classes:

FloatByteImmutablePair, FloatByteMutablePair
```
public interface FloatBytePair
```
Key Value Pair Interface that allows to reduce boxing/unboxing.

Field Summary

Fields
Modifier and Type Field and Description

static FloatBytePair EMPTY
Empty Reference for Immutable Pairs

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

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

Interface FloatBytePair

Field Summary

Method Summary

Field Detail

EMPTY

Method Detail

of

ofKey

ofValue

of

of

mutable

mutableKey

mutableValue

mutable

mutable

setFloatKey

getFloatKey

setByteValue

getByteValue

set

shallowCopy