IntFloatPair (Primitive-Collections 0.7.0 API)

All Known Implementing Classes:

IntFloatImmutablePair, IntFloatMutablePair
```
public interface IntFloatPair
```
Key Value Pair Interface that allows to reduce boxing/unboxing.

Field Summary

Fields
Modifier and Type Field and Description

static IntFloatPair EMPTY
Empty Reference for Immutable Pairs

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

Method Summary

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

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

Interface IntFloatPair

Field Summary

Method Summary

Field Detail

EMPTY

Method Detail

of

ofKey

ofValue

of

of

mutable

mutableKey

mutableValue

mutable

mutable

setIntKey

getIntKey

setFloatValue

getFloatValue

set

shallowCopy