Interface CharShortPair

  • All Superinterfaces:
    Pair<java.lang.Character,​java.lang.Short>
    All Known Implementing Classes:
    CharShortImmutablePair, CharShortMutablePair

    public interface CharShortPair
    extends Pair<java.lang.Character,​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 Description
      default java.lang.Character first()
      Deprecated.
      Please use the corresponding type-specific method instead.
      default CharShortPair first​(char l)
      Sets the left element of this pair (optional operation).
      default CharShortPair 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 CharShortPair key​(char l)
      Sets the left element of this pair (optional operation).
      default CharShortPair 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 CharShortPair left​(char l)
      Sets the left element of this pair (optional operation).
      default CharShortPair 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<CharShortPair> lexComparator()
      Returns a lexicographical comparator for pairs.
      static CharShortPair of​(char 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 CharShortPair right​(short r)
      Sets the right element of this pair (optional operation).
      default CharShortPair 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 CharShortPair second​(short r)
      Sets the right element of this pair (optional operation).
      default CharShortPair 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 CharShortPair value​(short r)
      Sets the right element of this pair (optional operation).
      default CharShortPair 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

      • 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.Short>
        Returns:
        the left element of this pair.
      • left

        default CharShortPair 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 CharShortPair 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.Short>
        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.Short>
        Returns:
        the left element of this pair.
      • first

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

        default CharShortPair 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 CharShortPair 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.Short>
        Parameters:
        l - a new value for the left element.
      • 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.
        Returns the right element of this pair.
        Specified by:
        right in interface Pair<java.lang.Character,​java.lang.Short>
        Returns:
        the right element of this pair.
      • right

        default CharShortPair right​(short 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 CharShortPair right​(java.lang.Short 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.Short>
        Parameters:
        l - a new value for the right element.
      • secondShort

        default short secondShort()
        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.Short 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.Short>
        Returns:
        the right element of this pair.
      • second

        default CharShortPair second​(short 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 CharShortPair second​(java.lang.Short 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.Short>
        Parameters:
        l - a new value for the right element.
      • valueShort

        default short valueShort()
        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.Short 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.Short>
        Returns:
        the right element of this pair.
      • value

        default CharShortPair value​(short 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 CharShortPair value​(java.lang.Short 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.Short>
        Parameters:
        l - a new value for the right element.
      • of

        static CharShortPair of​(char left,
                                short 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<CharShortPair> 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.