ByteLongPair (Primitive-Collections 0.7.0 API)

All Known Implementing Classes:

ByteLongImmutablePair, ByteLongMutablePair
```
public interface ByteLongPair
```
Key Value Pair Interface that allows to reduce boxing/unboxing.

Field Summary

Fields
Modifier and Type Field and Description

static ByteLongPair EMPTY
Empty Reference for Immutable Pairs

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

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

Interface ByteLongPair

Field Summary

Method Summary

Field Detail

EMPTY

Method Detail

of

ofKey

ofValue

of

of

mutable

mutableKey

mutableValue

mutable

mutable

setByteKey

getByteKey

setLongValue

getLongValue

set

shallowCopy