CharShortPair (Primitive-Collections 0.7.0 API)

All Known Implementing Classes:

CharShortImmutablePair, CharShortMutablePair
```
public interface CharShortPair
```
Key Value Pair Interface that allows to reduce boxing/unboxing.

Field Summary

Fields
Modifier and Type Field and Description

static CharShortPair EMPTY
Empty Reference for Immutable Pairs

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

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`char`	`getCharKey()`
`short`	`getShortValue()`
`static CharShortPair`	`mutable()`
`static CharShortPair`	`mutable(char key, short value)`
`static CharShortPair`	`mutable(CharShortPair pair)`
`static CharShortPair`	`mutableKey(char key)`
`static CharShortPair`	`mutableValue(short value)`
`static CharShortPair`	`of()`
`static CharShortPair`	`of(char key, short value)`
`static CharShortPair`	`of(CharShortPair pair)`
`static CharShortPair`	`ofKey(char key)`
`static CharShortPair`	`ofValue(short value)`
`CharShortPair`	`set(char key, short value)` Sets key and value of the Pair
`CharShortPair`	`setCharKey(char key)` Sets the Key of the Pair.
`CharShortPair`	`setShortValue(short value)` Sets the Value of the Pair.
`CharShortPair`	`shallowCopy()` Clones the Pair if it is mutable.

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

Interface CharShortPair

Field Summary

Method Summary

Field Detail

EMPTY

Method Detail

of

ofKey

ofValue

of

of

mutable

mutableKey

mutableValue

mutable

mutable

setCharKey

getCharKey

setShortValue

getShortValue

set

shallowCopy