IntCharPair (Primitive-Collections 0.7.0 API)

All Known Implementing Classes:

IntCharImmutablePair, IntCharMutablePair
```
public interface IntCharPair
```
Key Value Pair Interface that allows to reduce boxing/unboxing.

Field Summary

Fields
Modifier and Type Field and Description

static IntCharPair EMPTY
Empty Reference for Immutable Pairs

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

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

Interface IntCharPair

Field Summary

Method Summary

Field Detail

EMPTY

Method Detail

of

ofKey

ofValue

of

of

mutable

mutableKey

mutableValue

mutable

mutable

setIntKey

getIntKey

setCharValue

getCharValue

set

shallowCopy