ByteIntPair (Primitive-Collections 0.7.0 API)

All Known Implementing Classes:

ByteIntImmutablePair, ByteIntMutablePair
```
public interface ByteIntPair
```
Key Value Pair Interface that allows to reduce boxing/unboxing.

Field Summary

Fields
Modifier and Type Field and Description

static ByteIntPair EMPTY
Empty Reference for Immutable Pairs

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

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

Interface ByteIntPair

Field Summary

Method Summary

Field Detail

EMPTY

Method Detail

of

ofKey

ofValue

of

of

mutable

mutableKey

mutableValue

mutable

mutable

setByteKey

getByteKey

setIntValue

getIntValue

set

shallowCopy