org.spongepowered.api.data.value.mutable

Interface OptionalValue<E>

Type Parameters:

E - The type of element

All Superinterfaces:

BaseValue<Optional<E>>, Value<Optional<E>>

public interface OptionalValue<E>
extends Value<Optional<E>>

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

Method Summary

Modifier and Type	Method and Description
ImmutableOptionalValue<E>	asImmutable() Gets the ImmutableValue version of this Value such that all data is duplicated across to the new ImmutableValue.
OptionalValue<E>	copy() Makes an independent copy of this Value with the same initial data.
Value<E>	or(E defaultValue) Provides the value such that if the underlying value is null, the default value is returned as a Value, if the underlying value is present, the underlying value is returned as a Value.
OptionalValue<E>	set(Optional<E> value) Sets the underlying value to the provided value.
OptionalValue<E>	setTo(E value) Sets the underlying value, may be null.

Methods inherited from interface org.spongepowered.api.data.value.mutable.Value

transform

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

exists, get, getDefault, getDirect, getKey

Method Detail

set

OptionalValue<E> set(Optional<E> value)

Description copied from interface: Value

Sets the underlying value to the provided value.

Specified by:

set in interface Value<Optional<E>>

Parameters:

value - The value to set

Returns:

The owning ValueContainer

setTo

OptionalValue<E> setTo(@Nullable
                       E value)

Sets the underlying value, may be null.

Parameters:

value - The value to set

Returns:

This value, for chaining

or

Value<E> or(E defaultValue)

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

Parameters:

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

Returns:

A new Value with a non-null value

copy

OptionalValue<E> copy()

Description copied from interface: Value

Makes an independent copy of this Value with the same initial data. Both this value and the new value will refer to the same object initially.

Specified by:

copy in interface Value<Optional<E>>

Returns:

A new copy of this Value

asImmutable

ImmutableOptionalValue<E> asImmutable()

Description copied from interface: Value

Gets the ImmutableValue version of this Value such that all data is duplicated across to the new ImmutableValue. Note that once created, the ImmutableValue is not going to change.

Specified by:

asImmutable in interface Value<Optional<E>>

Returns:

A new ImmutableValue instance