Класс 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`, подходящее для отладки.

Методы, объявленные в классе java.lang.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
Требования к реализации:: Если значение присутствует, результат должен включать его строковое представление в результат. Пустые и присутствующие OptionalDouble должны быть однозначно различимы.
Возвращает:: строковое представление этого экземпляра

© 1993, 2021, 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/17/docs/api/java.base/java/util/OptionalDouble.html