ObjectDoublePair (Primitive-Collections 0.7.0 API)

Type Parameters:

T - the type of elements maintained by this Collection

All Known Implementing Classes:

ObjectDoubleImmutablePair, ObjectDoubleMutablePair
```
public interface ObjectDoublePair<T>
```
Key Value Pair Interface that allows to reduce boxing/unboxing.

Field Summary

Fields
Modifier and Type Field and Description

static ObjectDoublePair<?> EMPTY
Empty Reference for Immutable Pairs

Fields
Modifier and Type	Field and Description
`static ObjectDoublePair<?>`	`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()`
`T`	`getKey()`
`static <T> ObjectDoublePair<T>`	`mutable()`
`static <T> ObjectDoublePair<T>`	`mutable(ObjectDoublePair<T> pair)`
`static <T> ObjectDoublePair<T>`	`mutable(T key, double value)`
`static <T> ObjectDoublePair<T>`	`mutableKey(T key)`
`static <T> ObjectDoublePair<T>`	`mutableValue(double value)`
`static <T> ObjectDoublePair<T>`	`of()`
`static <T> ObjectDoublePair<T>`	`of(ObjectDoublePair<T> pair)`
`static <T> ObjectDoublePair<T>`	`of(T key, double value)`
`static <T> ObjectDoublePair<T>`	`ofKey(T key)`
`static <T> ObjectDoublePair<T>`	`ofValue(double value)`
`ObjectDoublePair<T>`	`set(T key, double value)` Sets key and value of the Pair
`ObjectDoublePair<T>`	`setDoubleValue(double value)` Sets the Value of the Pair.
`ObjectDoublePair<T>`	`setKey(T key)` Sets the Key of the Pair.
`ObjectDoublePair<T>`	`shallowCopy()` Clones the Pair if it is mutable.

- Field Detail
  - EMPTY
```
static final ObjectDoublePair<?> EMPTY
```
    Empty Reference for Immutable Pairs
- Method Detail
  - of
```
static <T> ObjectDoublePair<T> of()
```
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    Returns:
    
    empty Immutable Pair
  - ofKey
```
static <T> ObjectDoublePair<T> ofKey(T key)
```
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    Parameters:
    
    key - the key that should be in the pair
    
    Returns:
    
    Immutable Pair of Key
  - ofValue
```
static <T> ObjectDoublePair<T> ofValue(double value)
```
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    Parameters:
    
    value - the value that should be in the pair
    
    Returns:
    
    Immutable Pair of Value
  - of
```
static <T> ObjectDoublePair<T> of(T key,
                                  double value)
```
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    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 <T> ObjectDoublePair<T> of(ObjectDoublePair<T> pair)
```
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    Parameters:
    
    pair - the Pair that should be immutably copied
    
    Returns:
    
    a Immutable Copy of the Provided Pair
  - mutable
```
static <T> ObjectDoublePair<T> mutable()
```
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    Returns:
    
    empty Mutable Pair
  - mutableKey
```
static <T> ObjectDoublePair<T> mutableKey(T key)
```
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    Parameters:
    
    key - the key that should be in the pair
    
    Returns:
    
    Mutable Pair of key
  - mutableValue
```
static <T> ObjectDoublePair<T> mutableValue(double value)
```
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    Parameters:
    
    value - the value that should be in the pair
    
    Returns:
    
    Mutable Pair of value
  - mutable
```
static <T> ObjectDoublePair<T> mutable(T key,
                                       double value)
```
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    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 <T> ObjectDoublePair<T> mutable(ObjectDoublePair<T> pair)
```
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    Parameters:
    
    pair - the Pair that should be copied
    
    Returns:
    
    a Mutable Copy of the Provided Pair
  - setKey
```
ObjectDoublePair<T> setKey(T 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.
  - getKey
```
T getKey()
```
    Returns:
    
    the Key of the Pair
  - setDoubleValue
```
ObjectDoublePair<T> 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
```
ObjectDoublePair<T> set(T 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
```
ObjectDoublePair<T> shallowCopy()
```
    Clones the Pair if it is mutable.
    
    Returns:
    
    a New Mutable Instance if it is mutable

Interface ObjectDoublePair<T>

Field Summary

Method Summary

Field Detail

EMPTY

Method Detail

of

ofKey

ofValue

of

of

mutable

mutableKey

mutableValue

mutable

mutable

setKey

getKey

setDoubleValue

getDoubleValue

set

shallowCopy