org.spongepowered.api.data.value.mutable

Interface Value<E>

Type Parameters:

E - The type of element

All Superinterfaces:

BaseValue<E>

All Known Subinterfaces:

CollectionValue<E,C,V,I>, ListValue<E>, MapValue<K,V>, MutableBoundedValue<E>, OptionalValue<E>, PatternListValue, SetValue<E>, WeightedCollectionValue<E>

public interface Value<E>
extends BaseValue<E>

Represents a type of BaseValue that is mutable. Simply put, the underlying value can always be changed without creating a new Value.

Method Summary

Modifier and Type	Method and Description
ImmutableValue<E>	asImmutable() Gets the ImmutableValue version of this Value such that all data is duplicated across to the new ImmutableValue.
Value<E>	copy() Makes an independent copy of this Value with the same initial data.
Value<E>	set(E value) Sets the underlying value to the provided value.
Value<E>	transform(Function<E,E> function) Attempts to transform the underlying value based on the provided Function such that the result of Function.apply(Object) will replace the underlying value.

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

exists, get, getDefault, getDirect, getKey

Method Detail

set

Value<E> set(E value)

Sets the underlying value to the provided value.

Parameters:

value - The value to set

Returns:

The owning ValueContainer

transform

Value<E> transform(Function<E,E> function)

Attempts to transform the underlying value based on the provided Function such that the result of Function.apply(Object) will replace the underlying value.

Parameters:

function - The function to apply on the existing value

Returns:

The owning ValueContainer

asImmutable

ImmutableValue<E> asImmutable()

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.

Returns:

A new ImmutableValue instance

copy

Value<E> copy()

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.

Returns:

A new copy of this Value