ShortIntPair (Primitive-Collections 0.7.0 API)

All Known Implementing Classes:

ShortIntImmutablePair, ShortIntMutablePair
```
public interface ShortIntPair
```
Key Value Pair Interface that allows to reduce boxing/unboxing.

Field Summary

Fields
Modifier and Type Field and Description

static ShortIntPair EMPTY
Empty Reference for Immutable Pairs

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

Method Summary

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

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

Interface ShortIntPair

Field Summary

Method Summary

Field Detail

EMPTY

Method Detail

of

ofKey

ofValue

of

of

mutable

mutableKey

mutableValue

mutable

mutable

setShortKey

getShortKey

setIntValue

getIntValue

set

shallowCopy