Класс OptionalInt

java.lang.Object

java.util.OptionalInt

public final class OptionalInt extends Object

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

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

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

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

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

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

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

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

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

empty

public static OptionalInt empty()

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

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

of

public static OptionalInt of(int value)

Возвращает OptionalInt , описывающий заданное значение.

Параметры:: value - значение для описания
Возвращает:: OptionalInt со значением

getAsInt

public int getAsInt()

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

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

isPresent

public boolean isPresent()

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

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

isEmpty

public boolean isEmpty()

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

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

ifPresent

public void ifPresent(IntConsumer action)

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

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

ifPresentOrElse

public void ifPresentOrElse(IntConsumer action, Runnable emptyAction)

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

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

stream

public IntStream stream()

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

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

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


     Stream<OptionalInt> os = ..
     IntStream s = os.flatMapToInt(OptionalInt::stream)

Возвращает:

опциональное значение как IntStream

С тех пор как:

orElse

public int orElse(int other)

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

Параметры:: other - значение, которое должно быть возвращено, если значение отсутствует
Возвращает:: значение, если оно присутствует, в противном случае other

orElseGet

public int orElseGet(IntSupplier supplier)

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

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

orElseThrow

public int orElseThrow()

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

Возвращает:: значение, описываемое этим OptionalInt
Исключение:: NoSuchElementException - если значение отсутствует
С тех пор как:: 10

orElseThrow

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

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

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

equals

public boolean equals(Object obj)

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

он также является OptionalInt и;
оба экземпляра не содержат значения или;
настоящие значения «равны» друг другу через ==.

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

equals в классе Object

Параметры:

obj - объект для проверки на равенство

Возвращает:

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

См. также:

hashCode

public int hashCode()

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

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

hashCode в классе Object

Возвращает:

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

См. также:

toString

public String toString()

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

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

© 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/OptionalInt.html