Interface CharIntPair

  • All Superinterfaces:
    Pair<java.lang.Character,​java.lang.Integer>
    All Known Implementing Classes:
    CharIntImmutablePair, CharIntMutablePair

    public interface CharIntPair
    extends Pair<java.lang.Character,​java.lang.Integer>
    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 CharIntPair first​(char l)
      Sets the left element of this pair (optional operation).
      default CharIntPair 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 CharIntPair key​(char l)
      Sets the left element of this pair (optional operation).
      default CharIntPair 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 CharIntPair left​(char l)
      Sets the left element of this pair (optional operation).
      default CharIntPair 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<CharIntPair> lexComparator()
      Returns a lexicographical comparator for pairs.
      static CharIntPair of​(char left, int right)
      Returns a new type-specific immutable Pair with given left and right value.
      default java.lang.Integer right()
      Deprecated.
      Please use the corresponding type-specific method instead.
      default CharIntPair right​(int r)
      Sets the right element of this pair (optional operation).
      default CharIntPair right​(java.lang.Integer l)
      Deprecated.
      Please use the corresponding type-specific method instead.
      int rightInt()
      Returns the right element of this pair.
      default java.lang.Integer second()
      Deprecated.
      Please use the corresponding type-specific method instead.
      default CharIntPair second​(int r)
      Sets the right element of this pair (optional operation).
      default CharIntPair second​(java.lang.Integer l)
      Deprecated.
      Please use the corresponding type-specific method instead.
      default int secondInt()
      Returns the right element of this pair.
      default java.lang.Integer value()
      Deprecated.
      Please use the corresponding type-specific method instead.
      default CharIntPair value​(int r)
      Sets the right element of this pair (optional operation).
      default CharIntPair value​(java.lang.Integer l)
      Deprecated.
      Please use the corresponding type-specific method instead.
      default int valueInt()
      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.Integer>
        Returns:
        the left element of this pair.
      • left

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

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

        default CharIntPair 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 CharIntPair 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.Integer>
        Parameters:
        l - a new value for the left element.
      • rightInt

        int rightInt()
        Returns the right element of this pair.
        Returns:
        the right element of this pair.
      • right

        @Deprecated
        default java.lang.Integer 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.Integer>
        Returns:
        the right element of this pair.
      • right

        default CharIntPair right​(int 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 CharIntPair right​(java.lang.Integer 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.Integer>
        Parameters:
        l - a new value for the right element.
      • secondInt

        default int secondInt()
        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.Integer 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.Integer>
        Returns:
        the right element of this pair.
      • second

        default CharIntPair second​(int 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 CharIntPair second​(java.lang.Integer 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.Integer>
        Parameters:
        l - a new value for the right element.
      • valueInt

        default int valueInt()
        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.Integer 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.Integer>
        Returns:
        the right element of this pair.
      • value

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

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