OptionalLong

public final class OptionalLong extends Object

A container object which may or may not contain a long value. If a value is present, isPresent() will return true and getAsLong() will return the value.

Additional methods that depend on the presence or absence of a contained value are provided, such as orElse() (return a default value if value not present) and ifPresent() (execute a block of code if the value is present).

Public Method Summary

static OptionalLong
empty()
Returns an empty OptionalLong instance.
boolean
equals(Object obj)
Indicates whether some other object is "equal to" this OptionalLong.
long
getAsLong()
If a value is present in this OptionalLong, returns the value, otherwise throws NoSuchElementException.
int
hashCode()
Returns the hash code value of the present value, if any, or 0 (zero) if no value is present.
void
ifPresent(LongConsumer consumer)
Have the specified consumer accept the value if a value is present, otherwise do nothing.
boolean
isPresent()
Return true if there is a value present, otherwise false.
static OptionalLong
of(long value)
Return an OptionalLong with the specified value present.
long
orElse(long other)
Return the value if present, otherwise return other.
long
orElseGet(LongSupplier other)
Return the value if present, otherwise invoke other and return the result of that invocation.
<X extends Throwable> long
orElseThrow(Supplier<X> exceptionSupplier)
Return the contained value, if present, otherwise throw an exception to be created by the provided supplier.
String
toString()
Returns a string containing a concise, human-readable description of this object. Returns a non-empty string representation of this object suitable for debugging.

Inherited Method Summary

Public Methods

public static OptionalLong empty ()

Returns an empty OptionalLong instance. No value is present for this OptionalLong.

Returns
  • an empty OptionalLong.

public boolean equals (Object obj)

Indicates whether some other object is "equal to" this OptionalLong. The other object is considered equal if:

  • it is also an OptionalLong and;
  • both instances have no value present or;
  • the present values are "equal to" each other via ==.

Parameters
obj an object to be tested for equality
Returns
  • {code true} if the other object is "equal to" this object otherwise false

public long getAsLong ()

If a value is present in this OptionalLong, returns the value, otherwise throws NoSuchElementException.

Returns
  • the value held by this OptionalLong
Throws
NoSuchElementException if there is no value present
See Also

public int hashCode ()

Returns the hash code value of the present value, if any, or 0 (zero) if no value is present.

Returns
  • hash code value of the present value or 0 if no value is present

public void ifPresent (LongConsumer consumer)

Have the specified consumer accept the value if a value is present, otherwise do nothing.

Parameters
consumer block to be executed if a value is present
Throws
NullPointerException if value is present and consumer is null

public boolean isPresent ()

Return true if there is a value present, otherwise false.

Returns
  • true if there is a value present, otherwise false

public static OptionalLong of (long value)

Return an OptionalLong with the specified value present.

Parameters
value the value to be present
Returns
  • an OptionalLong with the value present

public long orElse (long other)

Return the value if present, otherwise return other.

Parameters
other the value to be returned if there is no value present
Returns
  • the value, if present, otherwise other

public long orElseGet (LongSupplier other)

Return the value if present, otherwise invoke other and return the result of that invocation.

Parameters
other a LongSupplier whose result is returned if no value is present
Returns
  • the value if present otherwise the result of other.getAsLong()
Throws
NullPointerException if value is not present and other is null

public long orElseThrow (Supplier<X> exceptionSupplier)

Return the contained value, if present, otherwise throw an exception to be created by the provided supplier.

Parameters
exceptionSupplier The supplier which will return the exception to be thrown
Returns
  • the present value