Package org.spongepowered.api.data.value

Interface Value.Immutable<E>

Type Parameters:

E - The type of value

All Superinterfaces:

Value<E>

All Known Subinterfaces:

CollectionValue.Immutable<E,C,I,M>, ListValue.Immutable<E>, MapValue.Immutable<K,V>, SetValue.Immutable<E>, WeightedCollectionValue.Immutable<E>

Enclosing interface:

Value<E>

public static interface Value.Immutable<E>
extends Value<E>

Represents an immutable representation of a Value where any modifications of the underlying value result in a new instance of an Value.Immutable and/or the ValueContainer if the ValueContainer too is immutable.

The basis for immutability is that once created, the value can not be changed for any reason. Change requires a new instance to be created. As the Value.Immutable always has a ValueContainer, it is recommended that the owning ValueContainer too is immutable, unless the Value.Immutable is being passed around for data processing. The underlying value of an Value.Immutable may be itself mutable, however utilizing any provided methods by any of the Value.Immutable classes is recommended.

Nested Class Summary

Nested classes/interfaces inherited from interface org.spongepowered.api.data.value.Value

Value.Factory, Value.Immutable<E>, Value.Mutable<E>

Method Summary

Modifier and Type	Method	Description
default Value.Immutable<E>	asImmutable()	Retrieves an immutable form of this value.
Value.Mutable<E>	asMutable()	Creates a mutable Value.Mutable for this Value.Immutable.
default Value.Mutable<E>	asMutableCopy()	Retrieves a copy in the mutable form of this value.
Value.Immutable<E>	transform(Function<E,E> function)	Retrieves the underlying value for this Value.Immutable and applies the given Function onto that value, after which, the product is sent to a new Value.Immutable replacing this one.
Value.Immutable<E>	with(E value)	Creates a new Value.Immutable 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 Value.Immutable.

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

get, key

Method Details

with

Value.Immutable<E> with(E value)

Creates a new Value.Immutable 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 Value.Immutable.

Parameters:

value - The value to replace

Returns:

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

transform

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

Retrieves the underlying value for this Value.Immutable and applies the given Function onto that value, after which, the product is sent to a new Value.Immutable 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.

Parameters:

function - The function to apply onto the existing value

Returns:

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

asMutable

Value.Mutable<E> asMutable()

Creates a mutable Value.Mutable for this Value.Immutable.

Specified by:

asMutable in interface Value<E>

Returns:

A mutable value

asMutableCopy

default Value.Mutable<E> asMutableCopy()

Description copied from interface: Value

Retrieves a copy in the mutable form of this value. The new is created with the same key and values.

Specified by:

asMutableCopy in interface Value<E>

Returns:

A mutable value

asImmutable

default Value.Immutable<E> asImmutable()

Description copied from interface: Value

Retrieves an immutable form of this value. Due to the vague nature of the value itself, some cases can already provide a Value.Immutable instance where this would simply return itself. In other cases, where the retrieved value is a Value.Mutable instance, a new immutable value is created with the same key and values.

Specified by:

asImmutable in interface Value<E>

Returns:

An immutable value