LongCharPair (Primitive-Collections 0.7.0 API)

All Known Implementing Classes:

LongCharImmutablePair, LongCharMutablePair
```
public interface LongCharPair
```
Key Value Pair Interface that allows to reduce boxing/unboxing.

Field Summary

Fields
Modifier and Type Field and Description

static LongCharPair EMPTY
Empty Reference for Immutable Pairs

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

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

Interface LongCharPair

Field Summary

Method Summary

Field Detail

EMPTY

Method Detail

of

ofKey

ofValue

of

of

mutable

mutableKey

mutableValue

mutable

mutable

setLongKey

getLongKey

setCharValue

getCharValue

set

shallowCopy