Module java.base
Package java.util

Class OptionalDouble

java.lang.Object
java.util.OptionalDouble
public final classOptionalDoubleextendsObject
A container object which may or may not contain adouble value. If a value is present,isPresent() returnstrue. If no value is present, the object is consideredempty andisPresent() returnsfalse.

Additional methods that depend on the presence or absence of a contained value are provided, such asorElse() (returns a default value if no value is present) andifPresent() (performs an action if a value is present).

This is avalue-based class; programmers should treat instances that areequal as interchangeable and should not use instances for synchronization, or unpredictable behavior may occur. For example, in a future release, synchronization may fail.

API Note:
OptionalDouble is primarily intended for use as a method return type where there is a clear need to represent "no result." A variable whose type isOptionalDouble should never itself benull; it should always point to anOptionalDouble instance.
Since:
1.8

  • Method Summary

    Modifier and Type
    Method
    Description
    Returns an emptyOptionalDouble instance.
    boolean
    Indicates whether some other object is "equal to" thisOptionalDouble.
    double
    If a value is present, returns the value, otherwise throwsNoSuchElementException.
    int
    Returns the hash code of the value, if present, otherwise0 (zero) if no value is present.
    void
    If a value is present, performs the given action with the value, otherwise does nothing.
    void
    If a value is present, performs the given action with the value, otherwise performs the given empty-based action.
    boolean
    If a value is not present, returnstrue, otherwisefalse.
    boolean
    If a value is present, returnstrue, otherwisefalse.
    of(double value)
    Returns anOptionalDouble describing the given value.
    double
    orElse(double other)
    If a value is present, returns the value, otherwise returnsother.
    double
    If a value is present, returns the value, otherwise returns the result produced by the supplying function.
    double
    If a value is present, returns the value, otherwise throwsNoSuchElementException.
    <X extendsThrowable>
    double
    orElseThrow(Supplier<? extends X> exceptionSupplier)
    If a value is present, returns the value, otherwise throws an exception produced by the exception supplying function.
    If a value is present, returns a sequentialDoubleStream containing only that value, otherwise returns an emptyDoubleStream.
    Returns a non-empty string representation of thisOptionalDouble suitable for debugging.

    Methods declared in class java.lang.Object

    clone,finalize,getClass,notify,notifyAll,wait,wait,wait

  • Method Details

    • empty

      public static OptionalDouble empty()
      Returns an emptyOptionalDouble instance. No value is present for thisOptionalDouble.
      API Note:
      Though it may be tempting to do so, avoid testing if an object is empty by comparing with== or!= against instances returned byOptionalDouble.empty(). There is no guarantee that it is a singleton. Instead, useisEmpty() orisPresent().
      Returns:
      an emptyOptionalDouble.

    • of

      public static OptionalDouble of(double value)
      Returns anOptionalDouble describing the given value.
      Parameters:
      value - the value to describe
      Returns:
      anOptionalDouble with the value present

    • getAsDouble

      public double getAsDouble()
      If a value is present, returns the value, otherwise throwsNoSuchElementException.
      API Note:
      The preferred alternative to this method isorElseThrow().
      Returns:
      the value described by thisOptionalDouble
      Throws:
      NoSuchElementException - if no value is present

    • isPresent

      public boolean isPresent()
      If a value is present, returnstrue, otherwisefalse.
      Returns:
      true if a value is present, otherwisefalse

    • isEmpty

      public boolean isEmpty()
      If a value is not present, returnstrue, otherwisefalse.
      Returns:
      true if a value is not present, otherwisefalse
      Since:
      11

    • ifPresent

      public void ifPresent(DoubleConsumer action)
      If a value is present, performs the given action with the value, otherwise does nothing.
      Parameters:
      action - the action to be performed, if a value is present
      Throws:
      NullPointerException - if value is present and the given action isnull

    • ifPresentOrElse

      public void ifPresentOrElse(DoubleConsumer action,Runnable emptyAction)
      If a value is present, performs the given action with the value, otherwise performs the given empty-based action.
      Parameters:
      action - the action to be performed, if a value is present
      emptyAction - the empty-based action to be performed, if no value is present
      Throws:
      NullPointerException - if a value is present and the given action isnull, or no value is present and the given empty-based action isnull.
      Since:
      9

    • stream

      public DoubleStream stream()
      If a value is present, returns a sequentialDoubleStream containing only that value, otherwise returns an emptyDoubleStream.
      API Note:
      This method can be used to transform aStream of optional doubles to aDoubleStream of present doubles:
           Stream<OptionalDouble> os = ..     DoubleStream s = os.flatMapToDouble(OptionalDouble::stream)
      Returns:
      the optional value as aDoubleStream
      Since:
      9

    • orElse

      public double orElse(double other)
      If a value is present, returns the value, otherwise returnsother.
      Parameters:
      other - the value to be returned, if no value is present
      Returns:
      the value, if present, otherwiseother

    • orElseGet

      public double orElseGet(DoubleSupplier supplier)
      If a value is present, returns the value, otherwise returns the result produced by the supplying function.
      Parameters:
      supplier - the supplying function that produces a value to be returned
      Returns:
      the value, if present, otherwise the result produced by the supplying function
      Throws:
      NullPointerException - if no value is present and the supplying function isnull

    • orElseThrow

      public double orElseThrow()
      If a value is present, returns the value, otherwise throwsNoSuchElementException.
      Returns:
      the value described by thisOptionalDouble
      Throws:
      NoSuchElementException - if no value is present
      Since:
      10

    • orElseThrow

      public <X extendsThrowable> double orElseThrow(Supplier<? extends X> exceptionSupplier) throwsX
      If a value is present, returns the value, otherwise throws an exception produced by the exception supplying function.
      API Note:
      A method reference to the exception constructor with an empty argument list can be used as the supplier. For example,IllegalStateException::new
      Type Parameters:
      X - Type of the exception to be thrown
      Parameters:
      exceptionSupplier - the supplying function that produces an exception to be thrown
      Returns:
      the value, if present
      Throws:
      X - if no value is present
      NullPointerException - if no value is present and the exception supplying function isnull

    • equals

      public boolean equals(Object obj)
      Indicates whether some other object is "equal to" thisOptionalDouble. The other object is considered equal if:
      • it is also anOptionalDouble and;
      • both instances have no value present or;
      • the present values are "equal to" each other viaDouble.compare() == 0.
      Overrides:
      equals in class Object
      Parameters:
      obj - an object to be tested for equality
      Returns:
      true if the other object is "equal to" this object otherwisefalse
      See Also:

    • hashCode

      public int hashCode()
      Returns the hash code of the value, if present, otherwise0 (zero) if no value is present.
      Overrides:
      hashCode in class Object
      Returns:
      hash code value of the present value or0 if no value is present
      See Also:

    • toString

      public String toString()
      Returns a non-empty string representation of thisOptionalDouble suitable for debugging. The exact presentation format is unspecified and may vary between implementations and versions.
      Overrides:
      toString in class Object
      Implementation Requirements:
      If a value is present the result must include its string representation in the result. Empty and presentOptionalDoubles must be unambiguously differentiable.
      Returns:
      the string representation of this instance