BooleanShortPair (boolean-common 8.5.13-SNAPSHOT API)

All Superinterfaces:

it.unimi.dsi.fastutil.Pair<java.lang.Boolean,java.lang.Short>

All Known Implementing Classes:

BooleanShortImmutablePair, BooleanShortMutablePair
```
public interface BooleanShortPair
extends it.unimi.dsi.fastutil.Pair<java.lang.Boolean,java.lang.Short>
```
A type-specific Pair; provides some additional methods that use polymorphism to avoid (un)boxing.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`default java.lang.Boolean`	`first()` Deprecated. Please use the corresponding type-specific method instead.
`default BooleanShortPair`	`first(boolean l)` Sets the left element of this pair (optional operation).
`default BooleanShortPair`	`first(java.lang.Boolean l)` Deprecated. Please use the corresponding type-specific method instead.
`default boolean`	`firstBoolean()` Returns the left element of this pair.
`default java.lang.Boolean`	`key()` Deprecated. Please use the corresponding type-specific method instead.
`default BooleanShortPair`	`key(boolean l)` Sets the left element of this pair (optional operation).
`default BooleanShortPair`	`key(java.lang.Boolean l)` Deprecated.
`default boolean`	`keyBoolean()` Returns the left element of this pair.
`default java.lang.Boolean`	`left()` Deprecated. Please use the corresponding type-specific method instead.
`default BooleanShortPair`	`left(boolean l)` Sets the left element of this pair (optional operation).
`default BooleanShortPair`	`left(java.lang.Boolean l)` Deprecated. Please use the corresponding type-specific method instead.
`boolean`	`leftBoolean()` Returns the left element of this pair.
`static java.util.Comparator<BooleanShortPair>`	`lexComparator()` Returns a lexicographical comparator for pairs.
`static BooleanShortPair`	`of(boolean left, short right)` Returns a new type-specific immutable `Pair` with given left and right value.
`default java.lang.Short`	`right()` Deprecated. Please use the corresponding type-specific method instead.
`default BooleanShortPair`	`right(short r)` Sets the right element of this pair (optional operation).
`default BooleanShortPair`	`right(java.lang.Short l)` Deprecated. Please use the corresponding type-specific method instead.
`short`	`rightShort()` Returns the right element of this pair.
`default java.lang.Short`	`second()` Deprecated. Please use the corresponding type-specific method instead.
`default BooleanShortPair`	`second(short r)` Sets the right element of this pair (optional operation).
`default BooleanShortPair`	`second(java.lang.Short l)` Deprecated. Please use the corresponding type-specific method instead.
`default short`	`secondShort()` Returns the right element of this pair.
`default java.lang.Short`	`value()` Deprecated. Please use the corresponding type-specific method instead.
`default BooleanShortPair`	`value(short r)` Sets the right element of this pair (optional operation).
`default BooleanShortPair`	`value(java.lang.Short l)` Deprecated. Please use the corresponding type-specific method instead.
`default short`	`valueShort()` Returns the right element of this pair.

- Method Detail
  - leftBoolean
```
boolean leftBoolean()
```
    Returns the left element of this pair.
    
    Returns:
    
    the left element of this pair.
  - left
```
@Deprecated
default java.lang.Boolean left()
```
    Deprecated. Please use the corresponding type-specific method instead.
    
    Specified by:
    
    left in interface it.unimi.dsi.fastutil.Pair<java.lang.Boolean,java.lang.Short>
  - left
```
default BooleanShortPair left(boolean l)
```
    Sets the left element of this pair (optional operation).
    
    Parameters:
    
    l - a new value for the left element.
  - left
```
@Deprecated
default BooleanShortPair left(java.lang.Boolean l)
```
    Deprecated. Please use the corresponding type-specific method instead.
    
    Specified by:
    
    left in interface it.unimi.dsi.fastutil.Pair<java.lang.Boolean,java.lang.Short>
  - firstBoolean
```
default boolean firstBoolean()
```
    Returns the left element of this pair.
    
    Returns:
    
    the left element of this pair.
  - first
```
@Deprecated
default java.lang.Boolean first()
```
    Deprecated. Please use the corresponding type-specific method instead.
    
    Specified by:
    
    first in interface it.unimi.dsi.fastutil.Pair<java.lang.Boolean,java.lang.Short>
  - first
```
default BooleanShortPair first(boolean l)
```
    Sets the left element of this pair (optional operation).
    
    Parameters:
    
    l - a new value for the left element.
  - first
```
@Deprecated
default BooleanShortPair first(java.lang.Boolean l)
```
    Deprecated. Please use the corresponding type-specific method instead.
    
    Specified by:
    
    first in interface it.unimi.dsi.fastutil.Pair<java.lang.Boolean,java.lang.Short>
  - keyBoolean
```
default boolean keyBoolean()
```
    Returns the left element of this pair.
    
    Returns:
    
    the left element of this pair.
  - key
```
@Deprecated
default java.lang.Boolean key()
```
    Deprecated. Please use the corresponding type-specific method instead.
    
    Specified by:
    
    key in interface it.unimi.dsi.fastutil.Pair<java.lang.Boolean,java.lang.Short>
  - key
```
default BooleanShortPair key(boolean l)
```
    Sets the left element of this pair (optional operation).
    
    Parameters:
    
    l - a new value for the left element.
  - key
```
@Deprecated
default BooleanShortPair key(java.lang.Boolean l)
```
    Deprecated.
    
    Specified by:
    
    key in interface it.unimi.dsi.fastutil.Pair<java.lang.Boolean,java.lang.Short>
  - rightShort
```
short rightShort()
```
    Returns the right element of this pair.
    
    Returns:
    
    the right element of this pair.
  - right
```
@Deprecated
default java.lang.Short right()
```
    Deprecated. Please use the corresponding type-specific method instead.
    
    Specified by:
    
    right in interface it.unimi.dsi.fastutil.Pair<java.lang.Boolean,java.lang.Short>
  - right
```
default BooleanShortPair right(short r)
```
    Sets the right element of this pair (optional operation).
    
    Parameters:
    
    r - a new value for the right element.
  - right
```
@Deprecated
default BooleanShortPair right(java.lang.Short l)
```
    Deprecated. Please use the corresponding type-specific method instead.
    
    Specified by:
    
    right in interface it.unimi.dsi.fastutil.Pair<java.lang.Boolean,java.lang.Short>
  - secondShort
```
default short secondShort()
```
    Returns the right element of this pair.
    
    Returns:
    
    the right element of this pair.
  - second
```
@Deprecated
default java.lang.Short second()
```
    Deprecated. Please use the corresponding type-specific method instead.
    
    Specified by:
    
    second in interface it.unimi.dsi.fastutil.Pair<java.lang.Boolean,java.lang.Short>
  - second
```
default BooleanShortPair second(short r)
```
    Sets the right element of this pair (optional operation).
    
    Parameters:
    
    r - a new value for the right element.
  - second
```
@Deprecated
default BooleanShortPair second(java.lang.Short l)
```
    Deprecated. Please use the corresponding type-specific method instead.
    
    Specified by:
    
    second in interface it.unimi.dsi.fastutil.Pair<java.lang.Boolean,java.lang.Short>
  - valueShort
```
default short valueShort()
```
    Returns the right element of this pair.
    
    Returns:
    
    the right element of this pair.
  - value
```
@Deprecated
default java.lang.Short value()
```
    Deprecated. Please use the corresponding type-specific method instead.
    
    Specified by:
    
    value in interface it.unimi.dsi.fastutil.Pair<java.lang.Boolean,java.lang.Short>
  - value
```
default BooleanShortPair value(short r)
```
    Sets the right element of this pair (optional operation).
    
    Parameters:
    
    r - a new value for the right element.
  - value
```
@Deprecated
default BooleanShortPair value(java.lang.Short l)
```
    Deprecated. Please use the corresponding type-specific method instead.
    
    Specified by:
    
    value in interface it.unimi.dsi.fastutil.Pair<java.lang.Boolean,java.lang.Short>
  - of
```
static BooleanShortPair of(boolean left,
                           short right)
```
    Returns a new type-specific immutable Pair with given left and right value.
    
    Specified by:
    
    of in interface it.unimi.dsi.fastutil.Pair<java.lang.Boolean,java.lang.Short>
    
    Parameters:
    
    left - the left value.
    
    right - the right value.
  - lexComparator
```
static java.util.Comparator<BooleanShortPair> lexComparator()
```
    Returns a lexicographical comparator for pairs.
    The comparator returned by this method implements lexicographical order. It compares first the left elements: if the result of the comparison is nonzero, it returns said result. Otherwise, this comparator returns the result of the comparison of the right elements.
    
    Specified by:
    
    lexComparator in interface it.unimi.dsi.fastutil.Pair<java.lang.Boolean,java.lang.Short>
    
    Returns:
    
    a lexicographical comparator for pairs.

Interface BooleanShortPair

Method Summary

Method Detail

leftBoolean

left

left

left

firstBoolean

first

first

first

keyBoolean

key

key

key

rightShort

right

right

right

secondShort

second

second

second

valueShort

value

value

value

of

lexComparator