ShortLongPair (Primitive-Collections 0.7.0 API)

All Known Implementing Classes:

ShortLongImmutablePair, ShortLongMutablePair
```
public interface ShortLongPair
```
Key Value Pair Interface that allows to reduce boxing/unboxing.

Field Summary

Fields
Modifier and Type Field and Description

static ShortLongPair EMPTY
Empty Reference for Immutable Pairs

Fields
Modifier and Type	Field and Description
`static ShortLongPair`	`EMPTY` Empty Reference for Immutable Pairs

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`long`	`getLongValue()`
`short`	`getShortKey()`
`static ShortLongPair`	`mutable()`
`static ShortLongPair`	`mutable(short key, long value)`
`static ShortLongPair`	`mutable(ShortLongPair pair)`
`static ShortLongPair`	`mutableKey(short key)`
`static ShortLongPair`	`mutableValue(long value)`
`static ShortLongPair`	`of()`
`static ShortLongPair`	`of(short key, long value)`
`static ShortLongPair`	`of(ShortLongPair pair)`
`static ShortLongPair`	`ofKey(short key)`
`static ShortLongPair`	`ofValue(long value)`
`ShortLongPair`	`set(short key, long value)` Sets key and value of the Pair
`ShortLongPair`	`setLongValue(long value)` Sets the Value of the Pair.
`ShortLongPair`	`setShortKey(short key)` Sets the Key of the Pair.
`ShortLongPair`	`shallowCopy()` Clones the Pair if it is mutable.

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

Interface ShortLongPair

Field Summary

Method Summary

Field Detail

EMPTY

Method Detail

of

ofKey

ofValue

of

of

mutable

mutableKey

mutableValue

mutable

mutable

setShortKey

getShortKey

setLongValue

getLongValue

set

shallowCopy