IntBytePair (Primitive-Collections 0.7.0 API)

All Known Implementing Classes:

IntByteImmutablePair, IntByteMutablePair
```
public interface IntBytePair
```
Key Value Pair Interface that allows to reduce boxing/unboxing.

Field Summary

Fields
Modifier and Type Field and Description

static IntBytePair EMPTY
Empty Reference for Immutable Pairs

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

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

Interface IntBytePair

Field Summary

Method Summary

Field Detail

EMPTY

Method Detail

of

ofKey

ofValue

of

of

mutable

mutableKey

mutableValue

mutable

mutable

setIntKey

getIntKey

setByteValue

getByteValue

set

shallowCopy