Interface ShortObjectPair<V>

  • All Superinterfaces:
    Pair<java.lang.Short,​V>
    All Known Implementing Classes:
    ShortObjectImmutablePair, ShortObjectMutablePair

    public interface ShortObjectPair<V>
    extends Pair<java.lang.Short,​V>
    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.Short first()
      Deprecated.
      Please use the corresponding type-specific method instead.
      default ShortObjectPair<V> first​(short l)
      Sets the left element of this pair (optional operation).
      default ShortObjectPair<V> first​(java.lang.Short l)
      Deprecated.
      Please use the corresponding type-specific method instead.
      default short firstShort()
      Returns the left element of this pair.
      default java.lang.Short key()
      Deprecated.
      Please use the corresponding type-specific method instead.
      default ShortObjectPair<V> key​(short l)
      Sets the left element of this pair (optional operation).
      default ShortObjectPair<V> key​(java.lang.Short l)
      Deprecated.
      default short keyShort()
      Returns the left element of this pair.
      default java.lang.Short left()
      Deprecated.
      Please use the corresponding type-specific method instead.
      default ShortObjectPair<V> left​(short l)
      Sets the left element of this pair (optional operation).
      default ShortObjectPair<V> left​(java.lang.Short l)
      Deprecated.
      Please use the corresponding type-specific method instead.
      short leftShort()
      Returns the left element of this pair.
      static <V> java.util.Comparator<ShortObjectPair<V>> lexComparator()
      Returns a lexicographical comparator for pairs.
      static <V> ShortObjectPair<V> of​(short left, V right)
      Returns a new type-specific immutable Pair with given left and right value.
    • Method Detail

      • leftShort

        short leftShort()
        Returns the left element of this pair.
        Returns:
        the left element of this pair.
      • left

        @Deprecated
        default java.lang.Short 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.Short,​V>
        Returns:
        the left element of this pair.
      • left

        default ShortObjectPair<V> left​(short 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 ShortObjectPair<V> left​(java.lang.Short 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.Short,​V>
        Parameters:
        l - a new value for the left element.
      • firstShort

        default short firstShort()
        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.Short 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.Short,​V>
        Returns:
        the left element of this pair.
      • first

        default ShortObjectPair<V> first​(short 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 ShortObjectPair<V> first​(java.lang.Short 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.Short,​V>
        Parameters:
        l - a new value for the left element.
      • keyShort

        default short keyShort()
        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.Short 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.Short,​V>
        Returns:
        the left element of this pair.
      • key

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

        static <V> ShortObjectPair<V> of​(short left,
                                         V 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 <V> java.util.Comparator<ShortObjectPair<V>> 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.