IntDoublePair (Primitive-Collections 0.7.0 API)

All Known Implementing Classes:

IntDoubleImmutablePair, IntDoubleMutablePair
```
public interface IntDoublePair
```
Key Value Pair Interface that allows to reduce boxing/unboxing.

Field Summary

Fields
Modifier and Type Field and Description

static IntDoublePair EMPTY
Empty Reference for Immutable Pairs

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

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`double`	`getDoubleValue()`
`int`	`getIntKey()`
`static IntDoublePair`	`mutable()`
`static IntDoublePair`	`mutable(int key, double value)`
`static IntDoublePair`	`mutable(IntDoublePair pair)`
`static IntDoublePair`	`mutableKey(int key)`
`static IntDoublePair`	`mutableValue(double value)`
`static IntDoublePair`	`of()`
`static IntDoublePair`	`of(int key, double value)`
`static IntDoublePair`	`of(IntDoublePair pair)`
`static IntDoublePair`	`ofKey(int key)`
`static IntDoublePair`	`ofValue(double value)`
`IntDoublePair`	`set(int key, double value)` Sets key and value of the Pair
`IntDoublePair`	`setDoubleValue(double value)` Sets the Value of the Pair.
`IntDoublePair`	`setIntKey(int key)` Sets the Key of the Pair.
`IntDoublePair`	`shallowCopy()` Clones the Pair if it is mutable.

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

Interface IntDoublePair

Field Summary

Method Summary

Field Detail

EMPTY

Method Detail

of

ofKey

ofValue

of

of

mutable

mutableKey

mutableValue

mutable

mutable

setIntKey

getIntKey

setDoubleValue

getDoubleValue

set

shallowCopy