Interface CharBooleanPair

All Superinterfaces:
Pair<Character, Boolean>
All Known Implementing Classes:
CharBooleanImmutablePair, CharBooleanMutablePair
public interface CharBooleanPair extends Pair<Character, Boolean>
A type-specific Pair; provides some additional methods that use polymorphism to avoid (un)boxing.

  • Method Summary

    Modifier and Type
    Method
    Description
    default Character
    first()
    Deprecated.
    Please use the corresponding type-specific method instead.
    default CharBooleanPair
    first(char l)
    Sets the left element of this pair (optional operation).
    default CharBooleanPair
    first(Character l)
    Deprecated.
    Please use the corresponding type-specific method instead.
    default char
    firstChar()
    Returns the left element of this pair.
    default Character
    key()
    Deprecated.
    Please use the corresponding type-specific method instead.
    default CharBooleanPair
    key(char l)
    Sets the left element of this pair (optional operation).
    default CharBooleanPair
    key(Character l)
    Deprecated.
    default char
    keyChar()
    Returns the left element of this pair.
    default Character
    left()
    Deprecated.
    Please use the corresponding type-specific method instead.
    default CharBooleanPair
    left(char l)
    Sets the left element of this pair (optional operation).
    default CharBooleanPair
    left(Character l)
    Deprecated.
    Please use the corresponding type-specific method instead.
    char
    leftChar()
    Returns the left element of this pair.
    static Comparator<CharBooleanPair>
    lexComparator()
    Returns a lexicographical comparator for pairs.
    static CharBooleanPair
    of(char left, boolean right)
    Returns a new type-specific immutable Pair with given left and right value.
    default Boolean
    right()
    Deprecated.
    Please use the corresponding type-specific method instead.
    default CharBooleanPair
    right(boolean r)
    Sets the right element of this pair (optional operation).
    default CharBooleanPair
    right(Boolean l)
    Deprecated.
    Please use the corresponding type-specific method instead.
    boolean
    rightBoolean()
    Returns the right element of this pair.
    default Boolean
    second()
    Deprecated.
    Please use the corresponding type-specific method instead.
    default CharBooleanPair
    second(boolean r)
    Sets the right element of this pair (optional operation).
    default CharBooleanPair
    second(Boolean l)
    Deprecated.
    Please use the corresponding type-specific method instead.
    default boolean
    secondBoolean()
    Returns the right element of this pair.
    default Boolean
    value()
    Deprecated.
    Please use the corresponding type-specific method instead.
    default CharBooleanPair
    value(boolean r)
    Sets the right element of this pair (optional operation).
    default CharBooleanPair
    value(Boolean l)
    Deprecated.
    Please use the corresponding type-specific method instead.
    default boolean
    valueBoolean()
    Returns the right element of this pair.

  • Method Details

    • leftChar

      char leftChar()
      Returns the left element of this pair.
      Returns:
      the left element of this pair.

    • left

      @Deprecated default Character left()
      Deprecated.
      Please use the corresponding type-specific method instead.
      Returns the left element of this pair.
      Specified by:
      left in interface Pair<Character, Boolean>
      Returns:
      the left element of this pair.

    • left

      default CharBooleanPair left(char l)
      Sets the left element of this pair (optional operation).
      Parameters:
      l - a new value for the left element.
      Implementation Specification:
      This implementation throws an UnsupportedOperationException.

    • left

      @Deprecated default CharBooleanPair left(Character l)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Sets the left element of this pair (optional operation).
      Specified by:
      left in interface Pair<Character, Boolean>
      Parameters:
      l - a new value for the left element.

    • firstChar

      default char firstChar()
      Returns the left element of this pair.
      Returns:
      the left element of this pair.
      Implementation Specification:
      This implementation delegates to left().

    • first

      @Deprecated default Character first()
      Deprecated.
      Please use the corresponding type-specific method instead.
      Returns the left element of this pair.
      Specified by:
      first in interface Pair<Character, Boolean>
      Returns:
      the left element of this pair.

    • first

      default CharBooleanPair first(char l)
      Sets the left element of this pair (optional operation).
      Parameters:
      l - a new value for the left element.
      Implementation Specification:
      This implementation delegates to Pair.left(Object).

    • first

      @Deprecated default CharBooleanPair first(Character l)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Sets the left element of this pair (optional operation).
      Specified by:
      first in interface Pair<Character, Boolean>
      Parameters:
      l - a new value for the left element.

    • keyChar

      default char keyChar()
      Returns the left element of this pair.
      Returns:
      the left element of this pair.
      Implementation Specification:
      This implementation delegates to left().

    • key

      @Deprecated default Character key()
      Deprecated.
      Please use the corresponding type-specific method instead.
      Returns the left element of this pair.
      Specified by:
      key in interface Pair<Character, Boolean>
      Returns:
      the left element of this pair.

    • key

      default CharBooleanPair key(char l)
      Sets the left element of this pair (optional operation).
      Parameters:
      l - a new value for the left element.
      Implementation Specification:
      This implementation delegates to Pair.left(Object).

    • key

      @Deprecated default CharBooleanPair key(Character l)
      Deprecated.
      Description copied from interface: Pair
      Sets the left element of this pair (optional operation).
      Specified by:
      key in interface Pair<Character, Boolean>
      Parameters:
      l - a new value for the left element.

    • rightBoolean

      boolean rightBoolean()
      Returns the right element of this pair.
      Returns:
      the right element of this pair.

    • right

      @Deprecated default Boolean right()
      Deprecated.
      Please use the corresponding type-specific method instead.
      Returns the right element of this pair.
      Specified by:
      right in interface Pair<Character, Boolean>
      Returns:
      the right element of this pair.

    • right

      default CharBooleanPair right(boolean r)
      Sets the right element of this pair (optional operation).
      Parameters:
      r - a new value for the right element.
      Implementation Specification:
      This implementation throws an UnsupportedOperationException.

    • right

      @Deprecated default CharBooleanPair right(Boolean l)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Sets the right element of this pair (optional operation).
      Specified by:
      right in interface Pair<Character, Boolean>
      Parameters:
      l - a new value for the right element.

    • secondBoolean

      default boolean secondBoolean()
      Returns the right element of this pair.
      Returns:
      the right element of this pair.
      Implementation Specification:
      This implementation delegates to right().

    • second

      @Deprecated default Boolean second()
      Deprecated.
      Please use the corresponding type-specific method instead.
      Returns the right element of this pair.
      Specified by:
      second in interface Pair<Character, Boolean>
      Returns:
      the right element of this pair.

    • second

      default CharBooleanPair second(boolean r)
      Sets the right element of this pair (optional operation).
      Parameters:
      r - a new value for the right element.
      Implementation Specification:
      This implementation delegates to Pair.right(Object).

    • second

      @Deprecated default CharBooleanPair second(Boolean l)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Sets the right element of this pair (optional operation).
      Specified by:
      second in interface Pair<Character, Boolean>
      Parameters:
      l - a new value for the right element.

    • valueBoolean

      default boolean valueBoolean()
      Returns the right element of this pair.
      Returns:
      the right element of this pair.
      Implementation Specification:
      This implementation delegates to right().

    • value

      @Deprecated default Boolean value()
      Deprecated.
      Please use the corresponding type-specific method instead.
      Returns the right element of this pair.
      Specified by:
      value in interface Pair<Character, Boolean>
      Returns:
      the right element of this pair.

    • value

      default CharBooleanPair value(boolean r)
      Sets the right element of this pair (optional operation).
      Parameters:
      r - a new value for the right element.
      Implementation Specification:
      This implementation delegates to Pair.right(Object).

    • value

      @Deprecated default CharBooleanPair value(Boolean l)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Sets the right element of this pair (optional operation).
      Specified by:
      value in interface Pair<Character, Boolean>
      Parameters:
      l - a new value for the right element.

    • of

      static CharBooleanPair of(char left, boolean right)
      Returns a new type-specific immutable Pair with given left and right value.
      Parameters:
      left - the left value.
      right - the right value.

    • lexComparator

      static Comparator<CharBooleanPair> 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.

      Returns:
      a lexicographical comparator for pairs.