Interface CharCharPair

All Superinterfaces:
Pair<java.lang.Character,​java.lang.Character>
All Known Subinterfaces:
CharCharSortedPair
All Known Implementing Classes:
CharCharImmutablePair, CharCharImmutableSortedPair, CharCharMutablePair

public interface CharCharPair
extends Pair<java.lang.Character,​java.lang.Character>
A type-specific Pair; provides some additional methods that use polymorphism to avoid (un)boxing.
  • Method Summary

    Modifier and Type Method Description
    default java.lang.Character first()
    Deprecated.
    Please use the corresponding type-specific method instead.
    default CharCharPair first​(char l)
    Sets the left element of this pair (optional operation).
    default CharCharPair first​(java.lang.Character l)
    Deprecated.
    Please use the corresponding type-specific method instead.
    default char firstChar()
    Returns the left element of this pair.
    default java.lang.Character key()
    Deprecated.
    Please use the corresponding type-specific method instead.
    default CharCharPair key​(char l)
    Sets the left element of this pair (optional operation).
    default CharCharPair key​(java.lang.Character l)
    Deprecated.
    default char keyChar()
    Returns the left element of this pair.
    default java.lang.Character left()
    Deprecated.
    Please use the corresponding type-specific method instead.
    default CharCharPair left​(char l)
    Sets the left element of this pair (optional operation).
    default CharCharPair left​(java.lang.Character l)
    Deprecated.
    Please use the corresponding type-specific method instead.
    char leftChar()
    Returns the left element of this pair.
    static java.util.Comparator<CharCharPair> lexComparator()
    Returns a lexicographical comparator for pairs.
    static CharCharPair of​(char left, char right)
    Returns a new type-specific immutable Pair with given left and right value.
    default java.lang.Character right()
    Deprecated.
    Please use the corresponding type-specific method instead.
    default CharCharPair right​(char r)
    Sets the right element of this pair (optional operation).
    default CharCharPair right​(java.lang.Character l)
    Deprecated.
    Please use the corresponding type-specific method instead.
    char rightChar()
    Returns the right element of this pair.
    default java.lang.Character second()
    Deprecated.
    Please use the corresponding type-specific method instead.
    default CharCharPair second​(char r)
    Sets the right element of this pair (optional operation).
    default CharCharPair second​(java.lang.Character l)
    Deprecated.
    Please use the corresponding type-specific method instead.
    default char secondChar()
    Returns the right element of this pair.
    default java.lang.Character value()
    Deprecated.
    Please use the corresponding type-specific method instead.
    default CharCharPair value​(char r)
    Sets the right element of this pair (optional operation).
    default CharCharPair value​(java.lang.Character l)
    Deprecated.
    Please use the corresponding type-specific method instead.
    default char valueChar()
    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 java.lang.Character left()
      Deprecated.
      Please use the corresponding type-specific method instead.
      Returns the left element of this pair.
      Specified by:
      left in interface Pair<java.lang.Character,​java.lang.Character>
      Returns:
      the left element of this pair.
    • left

      default CharCharPair 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 CharCharPair left​(java.lang.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<java.lang.Character,​java.lang.Character>
      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 java.lang.Character first()
      Deprecated.
      Please use the corresponding type-specific method instead.
      Returns the left element of this pair.
      Specified by:
      first in interface Pair<java.lang.Character,​java.lang.Character>
      Returns:
      the left element of this pair.
    • first

      default CharCharPair 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 CharCharPair first​(java.lang.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<java.lang.Character,​java.lang.Character>
      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 java.lang.Character key()
      Deprecated.
      Please use the corresponding type-specific method instead.
      Returns the left element of this pair.
      Specified by:
      key in interface Pair<java.lang.Character,​java.lang.Character>
      Returns:
      the left element of this pair.
    • key

      default CharCharPair 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 CharCharPair key​(java.lang.Character l)
      Deprecated.
      Description copied from interface: Pair
      Sets the left element of this pair (optional operation).
      Specified by:
      key in interface Pair<java.lang.Character,​java.lang.Character>
      Parameters:
      l - a new value for the left element.
    • rightChar

      char rightChar()
      Returns the right element of this pair.
      Returns:
      the right element of this pair.
    • right

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

      default CharCharPair right​(char 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 CharCharPair right​(java.lang.Character 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<java.lang.Character,​java.lang.Character>
      Parameters:
      l - a new value for the right element.
    • secondChar

      default char secondChar()
      Returns the right element of this pair.
      Returns:
      the right element of this pair.
      Implementation Specification:
      This implementation delegates to right().
    • second

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

      default CharCharPair second​(char 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 CharCharPair second​(java.lang.Character 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<java.lang.Character,​java.lang.Character>
      Parameters:
      l - a new value for the right element.
    • valueChar

      default char valueChar()
      Returns the right element of this pair.
      Returns:
      the right element of this pair.
      Implementation Specification:
      This implementation delegates to right().
    • value

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

      default CharCharPair value​(char 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 CharCharPair value​(java.lang.Character 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<java.lang.Character,​java.lang.Character>
      Parameters:
      l - a new value for the right element.
    • of

      static CharCharPair of​(char left, char 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 java.util.Comparator<CharCharPair> 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.