BooleanIntPair (Primitive-Collections 0.7.0 API)

All Known Implementing Classes:

BooleanIntImmutablePair, BooleanIntMutablePair
```
public interface BooleanIntPair
```
Key Value Pair Interface that allows to reduce boxing/unboxing.

Field Summary

Fields
Modifier and Type Field and Description

static BooleanIntPair EMPTY
Empty Reference for Immutable Pairs

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

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`boolean`	`getBooleanKey()`
`int`	`getIntValue()`
`static BooleanIntPair`	`mutable()`
`static BooleanIntPair`	`mutable(boolean key, int value)`
`static BooleanIntPair`	`mutable(BooleanIntPair pair)`
`static BooleanIntPair`	`mutableKey(boolean key)`
`static BooleanIntPair`	`mutableValue(int value)`
`static BooleanIntPair`	`of()`
`static BooleanIntPair`	`of(boolean key, int value)`
`static BooleanIntPair`	`of(BooleanIntPair pair)`
`static BooleanIntPair`	`ofKey(boolean key)`
`static BooleanIntPair`	`ofValue(int value)`
`BooleanIntPair`	`set(boolean key, int value)` Sets key and value of the Pair
`BooleanIntPair`	`setBooleanKey(boolean key)` Sets the Key of the Pair.
`BooleanIntPair`	`setIntValue(int value)` Sets the Value of the Pair.
`BooleanIntPair`	`shallowCopy()` Clones the Pair if it is mutable.

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

Interface BooleanIntPair

Field Summary

Method Summary

Field Detail

EMPTY

Method Detail

of

ofKey

ofValue

of

of

mutable

mutableKey

mutableValue

mutable

mutable

setBooleanKey

getBooleanKey

setIntValue

getIntValue

set

shallowCopy