Класс OptionalLong

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

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

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

Методы

empty

public static OptionalLong empty()

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

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

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

Возвращает:

пустой OptionalLong.

of

public static OptionalLong of(long value)

Возвращает OptionalLong с указанным присутствующим значением.

Параметры:

value - значение, которое должно присутствовать

Возвращает:

OptionalLong с присутствующим значением

getAsLong

public long getAsLong()

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

Возвращает:

значение, содержащееся в этом OptionalLong

Исключения:

NoSuchElementException - если значение отсутствует

См. также:

isPresent()

isPresent

public boolean isPresent()

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

Возвращает:

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

ifPresent

public void ifPresent(LongConsumer consumer)

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

Параметры:

consumer - блок, который должен быть выполнен, если значение присутствует

Исключения:

NullPointerException - если значение присутствует и consumer равно null

orElse

public long orElse(long other)

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

Параметры:

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

Возвращает:

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

orElseGet

public long orElseGet(LongSupplier other)

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

Параметры:

other - поставщик, результат которого возвращается, если значение отсутствует

Возвращает:

значение, если присутствует, в противном случае результат вызова other.getAsLong()

Исключения:

NullPointerException - если значение отсутствует и other равно null

orElseThrow

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

Возвращает содержащееся значение, если оно присутствует, в противном случае выбрасывает исключение, создаваемое предоставленным поставщиком.

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

В качестве поставщика можно использовать ссылку на метод конструктора исключения с пустым списком аргументов. Например, IllegalStateException::new

Параметры типа:

X - тип исключения, которое нужно сгенерировать

Параметры:

exceptionSupplier - Поставщик, который вернёт исключение для выброса

Возвращает:

настоящее значение

Исключения:

X - если значение отсутствует

NullPointerException - если значение отсутствует и exceptionSupplier равно null

X extends Throwable

equals

public boolean equals(Object obj)

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

• он также является OptionalLong, и;
• оба экземпляра не имеют значения или;
• присутствующие значения равны друг другу через ==.

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

equals в классе Object

Параметры:

obj - объект, который необходимо проверить на равенство

Возвращает:

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

См. также:

Object.hashCode(), HashMap

hashCode

public int hashCode()

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

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

hashCode в классе Object

Возвращает:

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

См. также:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

toString

public String toString()

getClass().getName() + '@' + Integer.toHexString(hashCode())

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

toString в классе Object

Требования к реализации:

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

Возвращает:

строковое представление этого экземпляра