Класс OptionalDouble

java.lang.Object

java.util.OptionalDouble

public final class OptionalDouble extends Object

Объект-контейнер, который может содержать или не содержать значение типа double. Если значение присутствует, isPresent() возвращает true. Если значение отсутствует, объект считается пустым, а isPresent() возвращает false.

Предусмотрены дополнительные методы, зависящие от наличия или отсутствия содержащегося значения, например orElse() (возвращает значение по умолчанию, если значение отсутствует) и ifPresent() (выполняет действие, если значение присутствует).

Это класс, основанный на значениях; программистам следует считать экземпляры, которые равны, взаимозаменяемыми и не использовать экземпляры для синхронизации, иначе может возникнуть непредсказуемое поведение. Например, в будущем выпуске синхронизация может завершиться с ошибкой.

Примечание к API:: OptionalDouble предназначен в первую очередь для использования в качестве типа возвращаемого значения метода, когда необходимо явно представить «отсутствие результата». Переменная типа OptionalDouble никогда не должна сама быть null; она всегда должна указывать на экземпляр OptionalDouble.
С версии:: 1.8

Краткое описание методов

Модификатор и тип	Метод	Описание
`static OptionalDouble`	`empty()`	Возвращает пустой экземпляр `OptionalDouble`.
`boolean`	`equals(Object obj)`	Указывает, является ли другой объект «равным» этому `OptionalDouble`.
`double`	`getAsDouble()`	Если значение присутствует, возвращает его, иначе выбрасывает `NoSuchElementException`.
`int`	`hashCode()`	Возвращает хеш-код значения, если оно присутствует, иначе возвращает `0` (ноль), если значение отсутствует.
`void`	`ifPresent(DoubleConsumer action)`	Если значение присутствует, выполняет указанное действие с этим значением, иначе ничего не делает.
`void`	`ifPresentOrElse(DoubleConsumer action, Runnable emptyAction)`	Если значение присутствует, выполняет указанное действие с этим значением, иначе выполняет указанное действие для пустого значения.
`boolean`	`isEmpty()`	Если значение отсутствует, возвращает `true`, иначе `false`.
`boolean`	`isPresent()`	Если значение присутствует, возвращает `true`, иначе `false`.
`static OptionalDouble`	`of(double value)`	Возвращает `OptionalDouble`, описывающий указанное значение.
`double`	`orElse(double other)`	Если значение присутствует, возвращает его, иначе возвращает `other`.
`double`	`orElseGet(DoubleSupplier supplier)`	Если значение присутствует, возвращает его, иначе возвращает результат, полученный от предоставляющей функции.
`double`	`orElseThrow()`	Если значение присутствует, возвращает его, иначе выбрасывает `NoSuchElementException`.
`<X extends Throwable> double`	`orElseThrow(Supplier<? extends X> exceptionSupplier)`	Если значение присутствует, возвращает его, иначе выбрасывает исключение, созданное функцией предоставления исключения.
`DoubleStream`	`stream()`	Если значение присутствует, возвращает последовательный `DoubleStream`, содержащий только это значение, иначе возвращает пустой `DoubleStream`.
`String`	`toString()`	Возвращает непустое строковое представление этого `OptionalDouble`, подходящее для отладки.

Методы, объявленные в классе Object

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

Подробное описание методов

empty

public static OptionalDouble empty()

Возвращает пустой экземпляр OptionalDouble. Для этого OptionalDouble значение отсутствует.

Примечание к API:: Хотя это может показаться заманчивым, не проверяйте, пуст ли объект, сравнивая его с == или != с экземплярами, возвращаемыми OptionalDouble.empty(). Нет гарантии, что это синглтон. Вместо этого используйте isEmpty() или isPresent().
Возвращает:: пустой OptionalDouble.

of

public static OptionalDouble of(double value)

Возвращает OptionalDouble, описывающий указанное значение.

Параметры:: value — значение, которое нужно описать
Возвращает:: OptionalDouble, содержащее значение

getAsDouble

public double getAsDouble()

Если значение присутствует, возвращает его, иначе выбрасывает NoSuchElementException.

Примечание к API:: Предпочтительной альтернативой этому методу является orElseThrow().
Возвращает:: значение, описываемое этим OptionalDouble
Выбрасывает:: NoSuchElementException — если значение отсутствует

isPresent

public boolean isPresent()

Если значение присутствует, возвращает true, иначе false.

Возвращает:: true, если значение присутствует, иначе false

isEmpty

public boolean isEmpty()

Если значение отсутствует, возвращает true, иначе false.

Возвращает:: true, если значение отсутствует, иначе false
С версии:: 11

ifPresent

public void ifPresent(DoubleConsumer action)

Если значение присутствует, выполняет указанное действие с этим значением, иначе ничего не делает.

Параметры:: action — действие, которое нужно выполнить, если значение присутствует
Выбрасывает:: NullPointerException — если значение присутствует, а указанное действие равно null

ifPresentOrElse

public void ifPresentOrElse(DoubleConsumer action, Runnable emptyAction)

Если значение присутствует, выполняет указанное действие с этим значением, иначе выполняет указанное действие для пустого значения.

Параметры:: action — действие, которое нужно выполнить, если значение присутствует; emptyAction — действие для пустого значения, которое нужно выполнить, если значение отсутствует
Выбрасывает:: NullPointerException — если значение присутствует, а указанное действие равно null, или если значение отсутствует, а указанное действие для пустого значения равно null.
С версии:: 9

stream

public DoubleStream stream()

Если значение присутствует, возвращает последовательный DoubleStream, содержащий только это значение, иначе возвращает пустой DoubleStream.

Примечание к API:

Этот метод можно использовать для преобразования Stream необязательных значений типа double в DoubleStream присутствующих значений типа double:

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

Возвращает:

необязательное значение в виде DoubleStream

С версии:

orElse

public double orElse(double other)

Если значение присутствует, возвращает его, иначе возвращает other.

Параметры:: other — значение, возвращаемое при отсутствии значения
Возвращает:: значение, если оно присутствует, иначе other

orElseGet

public double orElseGet(DoubleSupplier supplier)

Если значение присутствует, возвращает его, иначе возвращает результат, полученный от предоставляющей функции.

Параметры:: supplier — предоставляющая функция, создающая возвращаемое значение
Возвращает:: значение, если оно присутствует, иначе результат, полученный от предоставляющей функции
Выбрасывает:: NullPointerException — если значение отсутствует, а предоставляющая функция равна null

orElseThrow

public double orElseThrow()

Если значение присутствует, возвращает его, иначе выбрасывает NoSuchElementException.

Возвращает:: значение, описываемое этим OptionalDouble
Выбрасывает:: NoSuchElementException — если значение отсутствует
С версии:: 10

orElseThrow

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

Если значение присутствует, возвращает его, иначе выбрасывает исключение, созданное функцией предоставления исключения.

Примечание к API:: В качестве предоставляющей функции можно использовать ссылку на метод-конструктор исключения без аргументов. Например, IllegalStateException::new
Параметры типа:: X — тип выбрасываемого исключения
Параметры:: exceptionSupplier — предоставляющая функция, создающая исключение для выбрасывания
Возвращает:: значение, если оно присутствует
Выбрасывает:: X — если значение отсутствует; NullPointerException — если значение отсутствует, а функция предоставления исключения равна null

equals

public boolean equals(Object obj)

Указывает, является ли другой объект «равным» этому OptionalDouble. Другой объект считается равным, если:

он также является OptionalDouble;
оба экземпляра не содержат значения; или
присутствующие значения «равны» друг другу согласно Double.compare() == 0.

Переопределяет:

equals в классе Object

Параметры:

obj — объект, равенство которого нужно проверить

Возвращает:

true, если другой объект «равен» этому объекту, иначе false

См. также:

hashCode

public int hashCode()

Возвращает хеш-код значения, если оно присутствует, иначе возвращает 0 (ноль), если значение отсутствует.

Переопределяет:

hashCode в классе Object

Возвращает:

хеш-код присутствующего значения или 0, если значение отсутствует

См. также:

toString

public String toString()

Возвращает непустое строковое представление этого OptionalDouble, подходящее для отладки. Точный формат представления не определен и может различаться в разных реализациях и версиях.

Переопределяет:: toString в классе Object
Требования к реализации:: Если значение присутствует, результат должен включать его строковое представление. Пустые и содержащие значение OptionalDoubles должны однозначно различаться.
Возвращает:: строковое представление этого экземпляра

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/OptionalDouble.html