Interface CharBytePair

All Superinterfaces:
Pair<Character,Byte>
All Known Implementing Classes:
CharByteImmutablePair, CharByteMutablePair

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

    Modifier and Type
    Method
    Description
    default Character
    Deprecated.
    Please use the corresponding type-specific method instead.
    default CharBytePair
    first(char l)
    Sets the left element of this pair (optional operation).
    default CharBytePair
    Deprecated.
    Please use the corresponding type-specific method instead.
    default char
    Returns the left element of this pair.
    default Character
    key()
    Deprecated.
    Please use the corresponding type-specific method instead.
    default CharBytePair
    key(char l)
    Sets the left element of this pair (optional operation).
    default CharBytePair
    Deprecated.
    default char
    Returns the left element of this pair.
    default Character
    Deprecated.
    Please use the corresponding type-specific method instead.
    default CharBytePair
    left(char l)
    Sets the left element of this pair (optional operation).
    default CharBytePair
    Deprecated.
    Please use the corresponding type-specific method instead.
    char
    Returns the left element of this pair.
    Returns a lexicographical comparator for pairs.
    of(char left, byte right)
    Returns a new type-specific immutable Pair with given left and right value.
    default Byte
    Deprecated.
    Please use the corresponding type-specific method instead.
    default CharBytePair
    right(byte r)
    Sets the right element of this pair (optional operation).
    default CharBytePair
    Deprecated.
    Please use the corresponding type-specific method instead.
    byte
    Returns the right element of this pair.
    default Byte
    Deprecated.
    Please use the corresponding type-specific method instead.
    default CharBytePair
    second(byte r)
    Sets the right element of this pair (optional operation).
    default CharBytePair
    Deprecated.
    Please use the corresponding type-specific method instead.
    default byte
    Returns the right element of this pair.
    default Byte
    Deprecated.
    Please use the corresponding type-specific method instead.
    default CharBytePair
    value(byte r)
    Sets the right element of this pair (optional operation).
    default CharBytePair
    Deprecated.
    Please use the corresponding type-specific method instead.
    default byte
    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,Byte>
      Returns:
      the left element of this pair.
    • left

      default CharBytePair 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.
      Please use the corresponding type-specific method instead.
      Sets the left element of this pair (optional operation).
      Specified by:
      left in interface Pair<Character,Byte>
      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,Byte>
      Returns:
      the left element of this pair.
    • first

      default CharBytePair 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 CharBytePair 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,Byte>
      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,Byte>
      Returns:
      the left element of this pair.
    • key

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

      byte rightByte()
      Returns the right element of this pair.
      Returns:
      the right element of this pair.
    • right

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

      default CharBytePair right(byte 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 CharBytePair right(Byte 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,Byte>
      Parameters:
      l - a new value for the right element.
    • secondByte

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

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

      default CharBytePair second(byte 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 CharBytePair second(Byte 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,Byte>
      Parameters:
      l - a new value for the right element.
    • valueByte

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

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

      default CharBytePair value(byte 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 CharBytePair value(Byte 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,Byte>
      Parameters:
      l - a new value for the right element.
    • of

      static CharBytePair of(char left, byte 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<CharBytePair> 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.