LongBytePair (Primitive-Collections 0.7.0 API)

All Known Implementing Classes:

LongByteImmutablePair, LongByteMutablePair
```
public interface LongBytePair
```
Key Value Pair Interface that allows to reduce boxing/unboxing.

Field Summary

Fields
Modifier and Type Field and Description

static LongBytePair EMPTY
Empty Reference for Immutable Pairs

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

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

Interface LongBytePair

Field Summary

Method Summary

Field Detail

EMPTY

Method Detail

of

ofKey

ofValue

of

of

mutable

mutableKey

mutableValue

mutable

mutable

setLongKey

getLongKey

setByteValue

getByteValue

set

shallowCopy