Класс 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, 2023, 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/21/docs/api/java.base/java/util/OptionalDouble.html