ByteFloatPair (Primitive-Collections 0.7.0 API)

All Known Implementing Classes:

ByteFloatImmutablePair, ByteFloatMutablePair
```
public interface ByteFloatPair
```
Key Value Pair Interface that allows to reduce boxing/unboxing.

Field Summary

Fields
Modifier and Type Field and Description

static ByteFloatPair EMPTY
Empty Reference for Immutable Pairs

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

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

Interface ByteFloatPair

Field Summary

Method Summary

Field Detail

EMPTY

Method Detail

of

ofKey

ofValue

of

of

mutable

mutableKey

mutableValue

mutable

mutable

setByteKey

getByteKey

setFloatValue

getFloatValue

set

shallowCopy