Package org.spongepowered.api.data

Interface DataManipulator.Immutable

All Superinterfaces:

CopyableValueContainer, DataManipulator, ValueContainer

Enclosing interface:

DataManipulator

public static interface DataManipulator.Immutable
extends DataManipulator

Represents an immutable DataManipulator. Immutable meaning that the contained values are all likewise Value.Immutable, and as such, cannot be changed themselves, nor can the manipulator be modified to add or remove values. All methods such as with(Value) return new instances. It is guaranteed to be thread safe to access values from this container, and seeing as it does not change, can be passed around as a pseudo cache for templating. It is important to note that there is no guarantee on the validity of the stored Values that their own data does not "expire", cases may include outdated references of entities or worlds that no longer serve valid purposes.

See Also:

Immutable on Oracle Java Docs

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	DataManipulator.Immutable.Factory	A factory for generating DataManipulator.Immutables.

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

DataManipulator.Immutable, DataManipulator.Mutable

Method Summary

Modifier and Type	Method	Description
default DataManipulator.Immutable	asImmutable()	Gets an DataManipulator.Immutable copy of this DataManipulator such that all backed Value.Mutables are copied into Value.Immutable counterparts.
default DataManipulator.Immutable	copy()	Creates a clone copy of this CopyableValueContainer as a new CopyableValueContainer such that all the Values are safely duplicated to the new instance.
default <E> DataManipulator.Immutable	transform(Key<? extends Value<E>> key, Function<E,E> function)	Applies a transformation on the provided value if the key is available.
default <E> DataManipulator.Immutable	with(Key<? extends Value<E>> key, E value)	Creates a new DataManipulator.Immutable with the provided value if the Key is supported by this DataManipulator.Immutable without exception.
default <E> DataManipulator.Immutable	with(Value<E> value)	Creates a new DataManipulator.Immutable with the provided Value provided that the Value is supported by this DataManipulator.Immutable.
default DataManipulator.Immutable	without(Key<?> key)	Creates a new DataManipulator.Immutable without the given Key.

Methods inherited from interface org.spongepowered.api.data.DataManipulator

asMutable, asMutableCopy

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

get, getDouble, getInt, getKeys, getLong, getOrElse, getOrNull, getValue, getValues, require, requireValue, supports, supports

Method Detail

copy

default DataManipulator.Immutable copy()

Description copied from interface: CopyableValueContainer

Creates a clone copy of this CopyableValueContainer as a new CopyableValueContainer such that all the Values are safely duplicated to the new instance. It is not guaranteed that the returning container is of the same type as this container.

Specified by:

copy in interface CopyableValueContainer

Specified by:

copy in interface DataManipulator

Returns:

The new copy

asImmutable

default DataManipulator.Immutable asImmutable()

Description copied from interface: DataManipulator

Gets an DataManipulator.Immutable copy of this DataManipulator such that all backed Value.Mutables are copied into Value.Immutable counterparts. Any changes to this DataManipulator will NOT be reflected on the returned DataManipulator.Immutable and vice versa.

Specified by:

asImmutable in interface DataManipulator

Returns:

This DataManipulator's data copied into a DataManipulator.Immutable

with

default <E> DataManipulator.Immutable with(Key<? extends Value<E>> key,
                                           E value)

Creates a new DataManipulator.Immutable with the provided value if the Key is supported by this DataManipulator.Immutable without exception.

Type Parameters:

E - The type of value

Parameters:

key - The key to use

value - The value to set

Returns:

The new immutable data manipulator

without

default DataManipulator.Immutable without(Key<?> key)

Creates a new DataManipulator.Immutable without the given Key.

Parameters:

key - The key to use

Returns:

The new immutable data manipulator

with

default <E> DataManipulator.Immutable with(Value<E> value)

Creates a new DataManipulator.Immutable with the provided Value provided that the Value is supported by this DataManipulator.Immutable.

Type Parameters:

E - The type of value

Parameters:

value - The value to set

Returns:

The new immutable data manipulator

transform

default <E> DataManipulator.Immutable transform(Key<? extends Value<E>> key,
                                                Function<E,E> function)

Applies a transformation on the provided value if the key is available. This is the same as DataHolder.Immutable.transform(Key, Function).

Type Parameters:

E - The type of element

Parameters:

key - The key to use

function - The function to apply

Returns:

This manipulator, for chaining