Module org.microbean.invoke

Package org.microbean.invoke

Class FixedValueSupplier<T>

java.lang.Object

org.microbean.invoke.FixedValueSupplier<T>

All Implemented Interfaces:

Supplier<T>, OptionalSupplier<T>

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

An OptionalSupplier implementation that supplies a fixed value.

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.PRESENT when invoked.
final T	get()	Returns the value supplied at construction time, which may be null.
static final <T> FixedValueSupplier<T>	of(T value)	Returns a FixedValueSupplier supplying the supplied value.

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.PRESENT when invoked.

Specified by:

determinism in interface OptionalSupplier<T>

Returns:

OptionalSupplier.Determinism.PRESENT 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()

Returns the value supplied at construction time, which may be null.

Specified by:

get in interface OptionalSupplier<T>

Specified by:

get in interface Supplier<T>

Returns:

the value supplied at construction time

See Also:

• OptionalSupplier.determinism()

Idempotency:

This method is idempotent and deterministic.

Nullability:

This method may return null.

Thread Safety:

This method is safe for concurrent use by multiple threads.

of

public static final <T> FixedValueSupplier<T> of(T value)

Returns a FixedValueSupplier supplying the supplied value.

Type Parameters:

T - the type of the value the returned FixedValueSupplier will supply

Parameters:

value - the value the get() method will return; may be null

Returns:

a FixedValueSupplier supplying the supplied value

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.