Module me.linusdev.data

Package de.linusdev.data

Interface OptionalValue<V>

All Known Subinterfaces:

Container<K,V,O>, ListContainer<T>

All Known Implementing Classes:

ContainerImpl, ListContainerImpl, NonExistentContainer, NonExistentListContainer, OptionalValueImplementation

public interface OptionalValue<V>

Method Summary

Modifier and Type	Method	Description
boolean	exists()	If a OptionalValue exists, the value returned by get() can still be null.
V	get()	The actual value of class OptionalValue represented by this OptionalValue.
default <C> C	getAs()	Calls get() and casts it OptionalValue.
default boolean	isNull()
static <V> @NotNull OptionalValue<V>	of()
static <V> @NotNull OptionalValue<V>	of(V value)

Method Details

get

V get()

The actual value of class OptionalValue represented by this OptionalValue.

Returns:

OptionalValue or null

getAs

default <C> C getAs()

Calls get() and casts it OptionalValue.

Type Parameters:

C - class to cast to

Returns:

OptionalValue or null

Throws:

ClassCastException - if OptionalValue cannot be cast to OptionalValue.

isNull

default boolean isNull()

Returns:

true if get() will return null.

exists

boolean exists()

If a OptionalValue exists, the value returned by get() can still be null.

Returns:

true if this OptionalValue exists in the AbstractData this OptionalValue is of.

of

@Contract(value="_ -> new",
          pure=true)
@NotNull
static <V> @NotNull OptionalValue<V> of(V value)

Type Parameters:

V - type

Parameters:

value - value

Returns:

new OptionalValue, that exists.

of

@Contract(value=" -> new",
          pure=true)
@NotNull
static <V> @NotNull OptionalValue<V> of()

Type Parameters:

V - type

Returns:

new OptionalValue, that does not exist.