org.spongepowered.api.data.value.immutable

Interface ImmutableOptionalValue<E>

Type Parameters:

E - The type of element

All Superinterfaces:

BaseValue<Optional<E>>, ImmutableValue<Optional<E>>

public interface ImmutableOptionalValue<E>
extends ImmutableValue<Optional<E>>

Represents a ImmutableValue that can be Optional such that the underlying value may be present or null.

Method Summary

Modifier and Type	Method and Description
OptionalValue<E>	asMutable() Creates a mutable Value for this ImmutableValue.
ImmutableOptionalValue<E>	instead(E value) Creates a new ImmutableOptionalValue with the provided value, may be null.
ImmutableValue<E>	or(E value) Provides the value such that if the underlying value is null, the default value is returned as an ImmutableValue, if the underlying value is present, the underlying value is returned as a ImmutableValue.
ImmutableOptionalValue<E>	transform(Function<Optional<E>,Optional<E>> function) Retrieves the underlying value for this ImmutableValue and applies the given Function onto that value, after which, the product is sent to a new ImmutableValue replacing this one.
ImmutableOptionalValue<E>	with(Optional<E> value) Creates a new ImmutableValue with the given E typed value, such that if the owning ValueContainer is immutable, the ValueContainer too is recreated as a new instance with the new ImmutableValue.

Methods inherited from interface org.spongepowered.api.data.value.BaseValue

exists, get, getDefault, getDirect, getKey

Method Detail

with

ImmutableOptionalValue<E> with(Optional<E> value)

Description copied from interface: ImmutableValue

Creates a new ImmutableValue with the given E typed value, such that if the owning ValueContainer is immutable, the ValueContainer too is recreated as a new instance with the new ImmutableValue.

Specified by:

with in interface ImmutableValue<Optional<E>>

Parameters:

value - The value to replace

Returns:

The owning ValueContainer, a new instance if it too is immutable

transform

ImmutableOptionalValue<E> transform(Function<Optional<E>,Optional<E>> function)

Description copied from interface: ImmutableValue

Retrieves the underlying value for this ImmutableValue and applies the given Function onto that value, after which, the product is sent to a new ImmutableValue replacing this one.

If the ValueContainer too is immutable, a new instance of the ValueContainer may be created. If the ValueContainer is mutable, the same instance of the ValueContainer is retained.

Specified by:

transform in interface ImmutableValue<Optional<E>>

Parameters:

function - The function to apply onto the existing value

Returns:

The owning ValueContainer, a new instance if it too is immutable

instead

ImmutableOptionalValue<E> instead(@Nullable
                                  E value)

Creates a new ImmutableOptionalValue with the provided value, may be null.

Parameters:

value - The value

Returns:

The new value, for chaining

or

ImmutableValue<E> or(E value)

Provides the value such that if the underlying value is null, the default value is returned as an ImmutableValue, if the underlying value is present, the underlying value is returned as a ImmutableValue.

Parameters:

value - The value to substitute, if the underlying value is null

Returns:

A new ImmutableValue with a non-null value

asMutable

OptionalValue<E> asMutable()

Description copied from interface: ImmutableValue

Creates a mutable Value for this ImmutableValue.

Specified by:

asMutable in interface ImmutableValue<Optional<E>>

Returns:

A mutable value