Interface BooleanDoublePair

  • All Superinterfaces:
    Pair<java.lang.Boolean,​java.lang.Double>
    All Known Implementing Classes:
    BooleanDoubleImmutablePair, BooleanDoubleMutablePair

    public interface BooleanDoublePair
    extends Pair<java.lang.Boolean,​java.lang.Double>
    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.Boolean first()
      Deprecated.
      Please use the corresponding type-specific method instead.
      default BooleanDoublePair first​(boolean l)
      Sets the left element of this pair (optional operation).
      default BooleanDoublePair first​(java.lang.Boolean l)
      Deprecated.
      Please use the corresponding type-specific method instead.
      default boolean firstBoolean()
      Returns the left element of this pair.
      default java.lang.Boolean key()
      Deprecated.
      Please use the corresponding type-specific method instead.
      default BooleanDoublePair key​(boolean l)
      Sets the left element of this pair (optional operation).
      default BooleanDoublePair key​(java.lang.Boolean l)
      Deprecated.
      default boolean keyBoolean()
      Returns the left element of this pair.
      default java.lang.Boolean left()
      Deprecated.
      Please use the corresponding type-specific method instead.
      default BooleanDoublePair left​(boolean l)
      Sets the left element of this pair (optional operation).
      default BooleanDoublePair left​(java.lang.Boolean l)
      Deprecated.
      Please use the corresponding type-specific method instead.
      boolean leftBoolean()
      Returns the left element of this pair.
      static java.util.Comparator<BooleanDoublePair> lexComparator()
      Returns a lexicographical comparator for pairs.
      static BooleanDoublePair of​(boolean left, double right)
      Returns a new type-specific immutable Pair with given left and right value.
      default java.lang.Double right()
      Deprecated.
      Please use the corresponding type-specific method instead.
      default BooleanDoublePair right​(double r)
      Sets the right element of this pair (optional operation).
      default BooleanDoublePair right​(java.lang.Double l)
      Deprecated.
      Please use the corresponding type-specific method instead.
      double rightDouble()
      Returns the right element of this pair.
      default java.lang.Double second()
      Deprecated.
      Please use the corresponding type-specific method instead.
      default BooleanDoublePair second​(double r)
      Sets the right element of this pair (optional operation).
      default BooleanDoublePair second​(java.lang.Double l)
      Deprecated.
      Please use the corresponding type-specific method instead.
      default double secondDouble()
      Returns the right element of this pair.
      default java.lang.Double value()
      Deprecated.
      Please use the corresponding type-specific method instead.
      default BooleanDoublePair value​(double r)
      Sets the right element of this pair (optional operation).
      default BooleanDoublePair value​(java.lang.Double l)
      Deprecated.
      Please use the corresponding type-specific method instead.
      default double valueDouble()
      Returns the right element of this pair.
    • Method Detail

      • leftBoolean

        boolean leftBoolean()
        Returns the left element of this pair.
        Returns:
        the left element of this pair.
      • left

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

        default BooleanDoublePair left​(boolean 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 BooleanDoublePair left​(java.lang.Boolean 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.Boolean,​java.lang.Double>
        Parameters:
        l - a new value for the left element.
      • firstBoolean

        default boolean firstBoolean()
        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.Boolean 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.Boolean,​java.lang.Double>
        Returns:
        the left element of this pair.
      • first

        default BooleanDoublePair first​(boolean 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 BooleanDoublePair first​(java.lang.Boolean 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.Boolean,​java.lang.Double>
        Parameters:
        l - a new value for the left element.
      • keyBoolean

        default boolean keyBoolean()
        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.Boolean 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.Boolean,​java.lang.Double>
        Returns:
        the left element of this pair.
      • key

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

        double rightDouble()
        Returns the right element of this pair.
        Returns:
        the right element of this pair.
      • right

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

        default BooleanDoublePair right​(double 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 BooleanDoublePair right​(java.lang.Double 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.Boolean,​java.lang.Double>
        Parameters:
        l - a new value for the right element.
      • secondDouble

        default double secondDouble()
        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.Double 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.Boolean,​java.lang.Double>
        Returns:
        the right element of this pair.
      • second

        default BooleanDoublePair second​(double 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 BooleanDoublePair second​(java.lang.Double 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.Boolean,​java.lang.Double>
        Parameters:
        l - a new value for the right element.
      • valueDouble

        default double valueDouble()
        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.Double 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.Boolean,​java.lang.Double>
        Returns:
        the right element of this pair.
      • value

        default BooleanDoublePair value​(double 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 BooleanDoublePair value​(java.lang.Double 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.Boolean,​java.lang.Double>
        Parameters:
        l - a new value for the right element.
      • of

        static BooleanDoublePair of​(boolean left,
                                    double 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<BooleanDoublePair> 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.