Module org.microbean.invoke

Package org.microbean.invoke

Class Absence<T>

java.lang.Object

org.microbean.invoke.Absence<T>

All Implemented Interfaces:

Supplier<T>, OptionalSupplier<T>

public final class Absence<T>
extends Object
implements OptionalSupplier<T>

An OptionalSupplier implementation that indicates permanent absence.

Author:

Laird Nelson

Nested Class Summary

Nested classes/interfaces inherited from interface org.microbean.invoke.OptionalSupplier

OptionalSupplier.Determinism

Method Summary

Modifier and Type	Method	Description
final OptionalSupplier.Determinism	determinism()	Returns OptionalSupplier.Determinism.ABSENT when invoked.
final T	get()	Throws a NoSuchElementException when invoked.
static final <T> Absence<T>	instance()	Returns the sole instance of this class.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.microbean.invoke.OptionalSupplier

exceptionally, handle, ifPresent, ifPresentOrElse, optional, optional, optional, orElse, orElseGet, orElseThrow, orElseThrow, stream

Method Details

determinism

public final OptionalSupplier.Determinism determinism()

Returns OptionalSupplier.Determinism.ABSENT when invoked.

Specified by:

determinism in interface OptionalSupplier<T>

Returns:

OptionalSupplier.Determinism.ABSENT when invoked

Idempotency:

This method is idempotent and deterministic.

Nullability:

This method never returns null.

Thread Safety:

This method is safe for concurrent use by multiple threads.

get

public final T get()

Throws a NoSuchElementException when invoked.

Specified by:

get in interface OptionalSupplier<T>

Specified by:

get in interface Supplier<T>

Returns:

nothing

Throws:

NoSuchElementException - when invoked

See Also:

• OptionalSupplier.determinism()

Idempotency:

This method is idempotent and deterministic.

Nullability:

This method never returns null.

Thread Safety:

This method is safe for concurrent use by multiple threads.

instance

public static final <T> Absence<T> instance()

Returns the sole instance of this class.

Type Parameters:

T - the type of the nonexistent value the returned Absence will never supply

Returns:

the sole instance of this class

Idempotency:

This method is idempotent and deterministic.

Nullability:

This method never returns null.

Thread Safety:

This method is safe for concurrent use by multiple threads.