Класс OptionalInt

java.lang.Object

java.util.OptionalInt

public final class OptionalInt extends Object

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

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

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

Примечание к API:: OptionalInt в первую очередь предназначен для использования в качестве типа возвращаемого значения метода, когда необходимо явно представить «отсутствие результата». Переменная типа OptionalInt никогда не должна сама быть null; она всегда должна ссылаться на экземпляр OptionalInt.
С версии:: 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`, подходящее для отладки.

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

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

Модификатор и тип	Метод	Описание
`protected Object`	`clone()`	Создает и возвращает копию этого объекта.
`protected void`	`finalize()`	Устарело, планируется удаление: этот элемент API может быть удален в будущей версии. Финализация устарела и может быть удалена в будущей версии.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого `Object`.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`final void`	`wait()`	Заставляет текущий поток ожидать пробуждения, обычно посредством уведомления или прерывания.
`final void`	`wait(long timeoutMillis)`	Заставляет текущий поток ожидать пробуждения, обычно посредством уведомления или прерывания, либо истечения определенного промежутка реального времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Заставляет текущий поток ожидать пробуждения, обычно посредством уведомления или прерывания, либо истечения определенного промежутка реального времени.

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

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, 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.