OpenJDK 27 · java.util.OptionalDouble · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private static final OptionalDouble	EMPTY Common instance for `empty()`.
private final boolean	isPresent If true then the value is present, otherwise indicates no value is present
private final double	value

Access	Constructor and Description
private	OptionalDouble() Construct an empty instance.
private	OptionalDouble(double the double value to describe. value) Construct an instance with the described value.

Method Summary

Modifier and Type	Method and Description
public static OptionalDouble	Returns: an empty `OptionalDouble`. empty() Returns an empty `OptionalDouble` instance.
public boolean	Returns: `true` if the other object is "equal to" this object otherwise `false` equals(Object an object to be tested for equality obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this `OptionalDouble`.
public double	Returns: the value described by this `OptionalDouble` getAsDouble() If a value is present, returns the value, otherwise throws `NoSuchElementException`.
public int	Returns: hash code value of the present value or `0` if no value is present hashCode() Overrides java.lang.Object.hashCode. Returns the hash code of the value, if present, otherwise `0` (zero) if no value is present.
public void	ifPresent(DoubleConsumer the action to be performed, if a value is present action) If a value is present, performs the given action with the value, otherwise does nothing.
public void	ifPresentOrElse(DoubleConsumer the action to be performed, if a value is present action, Runnable the empty-based action to be performed, if no value is present emptyAction) If a value is present, performs the given action with the value, otherwise performs the given empty-based action.
public boolean	Returns: `true` if a value is not present, otherwise `false` isEmpty() If a value is not present, returns `true`, otherwise `false`.
public boolean	Returns: `true` if a value is present, otherwise `false` isPresent() If a value is present, returns `true`, otherwise `false`.
public static OptionalDouble	Returns: an `OptionalDouble` with the value present of(double the value to describe value) Returns an `OptionalDouble` describing the given value.
public double	Returns: the value, if present, otherwise `other` orElse(double the value to be returned, if no value is present other) If a value is present, returns the value, otherwise returns `other`.
public double	Returns: the value, if present, otherwise the result produced by the supplying function orElseGet(DoubleSupplier the supplying function that produces a value to be returned supplier) If a value is present, returns the value, otherwise returns the result produced by the supplying function.
public double	Returns: the value described by this `OptionalDouble` orElseThrow() If a value is present, returns the value, otherwise throws `NoSuchElementException`.
public < Type of the exception to be thrown X extends Throwable> double	Returns: the value, if present orElseThrow(Supplier<? extends X> the supplying function that produces an exception to be thrown exceptionSupplier) If a value is present, returns the value, otherwise throws an exception produced by the exception supplying function.
public DoubleStream	Returns: the optional value as a `DoubleStream` stream() If a value is present, returns a sequential `DoubleStream` containing only that value, otherwise returns an empty `DoubleStream`.
public String	Returns: the string representation of this instance toString() Overrides java.lang.Object.toString. Returns a non-empty string representation of this `OptionalDouble` suitable for debugging.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

EMPTY	back to summary
private static final OptionalDouble EMPTY Common instance for `empty()`.

isPresent	back to summary
private final boolean isPresent If true then the value is present, otherwise indicates no value is present

value	back to summary
private final double value

OptionalDouble	back to summary
private OptionalDouble() Construct an empty instance. Implementation Note generally only one empty instance, `OptionalDouble#EMPTY`, should exist per VM.

OptionalDouble	back to summary
private OptionalDouble(double value) Construct an instance with the described value. Parameters value:double the double value to describe.

Method Detail

empty back to summary

empty	back to summary
public static OptionalDouble empty() Returns an empty `OptionalDouble` instance. No value is present for this `OptionalDouble`. API Note Though it may be tempting to do so, avoid testing if an object is empty by comparing with `==` or `!=` against instances returned by `OptionalDouble.empty()`. There is no guarantee that it is a singleton. Instead, use `isEmpty()` or `isPresent()`. Returns:OptionalDouble an empty `OptionalDouble`.

public static OptionalDouble empty()

Returns an empty OptionalDouble instance. No value is present for this OptionalDouble.

API Note

Though it may be tempting to do so, avoid testing if an object is empty by comparing with == or != against instances returned by OptionalDouble.empty(). There is no guarantee that it is a singleton. Instead, use isEmpty() or isPresent().

Returns:OptionalDouble: an empty OptionalDouble.

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this `OptionalDouble`. The other object is considered equal if: it is also an `OptionalDouble` and; both instances have no value present or; the present values are "equal to" each other via `Double.compare() == 0`. Parameters obj:Object an object to be tested for equality Returns:boolean `true` if the other object is "equal to" this object otherwise `false` Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this OptionalDouble. The other object is considered equal if:

it is also an OptionalDouble and;
both instances have no value present or;
the present values are "equal to" each other via Double.compare() == 0.

Parameters

obj:Object: an object to be tested for equality

Returns:boolean

true if the other object is "equal to" this object otherwise false

Annotations

@Override

getAsDouble back to summary

getAsDouble	back to summary
public double getAsDouble() If a value is present, returns the value, otherwise throws `NoSuchElementException`. API Note The preferred alternative to this method is `orElseThrow()`. Returns:double the value described by this `OptionalDouble` Exceptions NoSuchElementException: if no value is present

public double getAsDouble()

If a value is present, returns the value, otherwise throws NoSuchElementException.

API Note

The preferred alternative to this method is orElseThrow().

Returns:double

the value described by this OptionalDouble

Exceptions

NoSuchElementException:: if no value is present

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Returns the hash code of the value, if present, otherwise `0` (zero) if no value is present. Returns:int hash code value of the present value or `0` if no value is present Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Returns the hash code of the value, if present, otherwise 0 (zero) if no value is present.

Returns:int

hash code value of the present value or 0 if no value is present

Annotations

@Override

ifPresent back to summary

ifPresent	back to summary
public void ifPresent(DoubleConsumer action) If a value is present, performs the given action with the value, otherwise does nothing. Parameters action:DoubleConsumer the action to be performed, if a value is present Exceptions NullPointerException: if value is present and the given action is `null`

public void ifPresent(DoubleConsumer action)

If a value is present, performs the given action with the value, otherwise does nothing.

Parameters

action:DoubleConsumer: the action to be performed, if a value is present

Exceptions

NullPointerException:: if value is present and the given action is null

ifPresentOrElse back to summary

ifPresentOrElse	back to summary
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:DoubleConsumer the action to be performed, if a value is present emptyAction:Runnable the empty-based action to be performed, if no value is present Exceptions NullPointerException: if a value is present and the given action is `null`, or no value is present and the given empty-based action is `null`. Since 9

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:DoubleConsumer: the action to be performed, if a value is present
emptyAction:Runnable: the empty-based action to be performed, if no value is present

Exceptions

NullPointerException:: if a value is present and the given action is null, or no value is present and the given empty-based action is null.

Since

isEmpty back to summary

isEmpty	back to summary
public boolean isEmpty() If a value is not present, returns `true`, otherwise `false`. Returns:boolean `true` if a value is not present, otherwise `false` Since 11

public boolean isEmpty()

If a value is not present, returns true, otherwise false.

Returns:boolean: true if a value is not present, otherwise false
Since: 11

isPresent back to summary

isPresent	back to summary
public boolean isPresent() If a value is present, returns `true`, otherwise `false`. Returns:boolean `true` if a value is present, otherwise `false`

public boolean isPresent()

If a value is present, returns true, otherwise false.

Returns:boolean: true if a value is present, otherwise false

of back to summary

of	back to summary
public static OptionalDouble of(double value) Returns an `OptionalDouble` describing the given value. Parameters value:double the value to describe Returns:OptionalDouble an `OptionalDouble` with the value present

public static OptionalDouble of(double value)

Returns an OptionalDouble describing the given value.

Parameters

value:double: the value to describe

Returns:OptionalDouble

an OptionalDouble with the value present

orElse back to summary

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

public double orElse(double other)

If a value is present, returns the value, otherwise returns other.

Parameters

other:double: the value to be returned, if no value is present

Returns:double

the value, if present, otherwise other

orElseGet back to summary

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

public double orElseGet(DoubleSupplier supplier)

If a value is present, returns the value, otherwise returns the result produced by the supplying function.

Parameters

supplier:DoubleSupplier: the supplying function that produces a value to be returned

Returns:double

the value, if present, otherwise the result produced by the supplying function

Exceptions

NullPointerException:: if no value is present and the supplying function is null

orElseThrow back to summary

orElseThrow	back to summary
public double orElseThrow() If a value is present, returns the value, otherwise throws `NoSuchElementException`. Returns:double the value described by this `OptionalDouble` Exceptions NoSuchElementException: if no value is present Since 10

public double orElseThrow()

If a value is present, returns the value, otherwise throws NoSuchElementException.

Returns:double

the value described by this OptionalDouble

Exceptions

NoSuchElementException:: if no value is present

Since

orElseThrow back to summary

orElseThrow	back to summary
public <X extends Throwable> double orElseThrow(Supplier<? extends X> exceptionSupplier) throws Supplier-:X 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` Parameters <X> Type of the exception to be thrown exceptionSupplier:Supplier<? extends X> the supplying function that produces an exception to be thrown Returns:double the value, if present Exceptions Supplier-:X: if no value is present NullPointerException: if no value is present and the exception supplying function is `null`

public <X extends Throwable> double orElseThrow(Supplier<? extends X> exceptionSupplier) throws Supplier-:X

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

Parameters

<X>: Type of the exception to be thrown
exceptionSupplier:Supplier<? extends X>: the supplying function that produces an exception to be thrown

Returns:double

the value, if present

Exceptions

Supplier-:X:: if no value is present
NullPointerException:: if no value is present and the exception supplying function is null

stream back to summary

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

public DoubleStream stream()

If a value is present, returns a sequential DoubleStream containing only that value, otherwise returns an empty DoubleStream.

API Note

This method can be used to transform a Stream of optional doubles to a DoubleStream of present doubles:

Stream<OptionalDouble> os = ..
    DoubleStream s = os.flatMapToDouble(OptionalDouble::stream)

Returns:DoubleStream: the optional value as a DoubleStream
Since: 9

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Returns a non-empty string representation of this `OptionalDouble` suitable for debugging. The exact presentation format is unspecified and may vary between implementations and versions. Implementation Specification If a value is present the result must include its string representation in the result. Empty and present `OptionalDouble`s must be unambiguously differentiable. Returns:String the string representation of this instance Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Returns a non-empty string representation of this OptionalDouble suitable for debugging. The exact presentation format is unspecified and may vary between implementations and versions.

Implementation Specification

If a value is present the result must include its string representation in the result. Empty and present OptionalDoubles must be unambiguously differentiable.

Returns:String

the string representation of this instance

Annotations

@Override

public final Class OptionalDouble

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail