Package org.spongepowered.api.data

Interface DataManipulator

All Superinterfaces:

CopyableValueContainer, ValueContainer

All Known Subinterfaces:

DataManipulator.Immutable, DataManipulator.Mutable

public interface DataManipulator
extends CopyableValueContainer

Represents a changelist of data that can be applied to a DataHolder.Mutable. With a DataManipulator, specific sets of mutable data can be represented and changed outside the live state of the DataHolder.Mutable.

DataManipulators are serializable such that they can be serialized and deserialized from persistence, and applied to DataHolders, even with specialized Functions to use DataManipulator.Mutable.transform(Key, Function) such that the DataManipulator is always returned.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	DataManipulator.Immutable	Represents an immutable DataManipulator.
static interface	DataManipulator.Mutable	Represents a changelist of data that can be applied to a DataHolder.

Method Summary

Modifier and Type	Method	Description
DataManipulator.Immutable	asImmutable()	Gets an DataManipulator.Immutable copy of this DataManipulator such that all backed Value.Mutables are copied into Value.Immutable counterparts.
DataManipulator.Mutable	asMutable()	Gets a DataManipulator.Mutable copy of this DataManipulator such that all backed Values are copied into their Value.Mutable counterparts.
DataManipulator.Mutable	asMutableCopy()	Creates a new DataManipulator.Mutable copy of all Values contained in this DataManipulator, regardless whether this is a mutable instance already.
DataManipulator	copy()	Creates a clone copy of this CopyableValueContainer as a new CopyableValueContainer such that all the Values are safely duplicated to the new instance.
static DataManipulator.Immutable	immutableOf()	Gets a empty DataManipulator.Immutable.
static DataManipulator.Immutable	immutableOf(Iterable<? extends Value<?>> values)	Creates a DataManipulator.Immutable view directly based on the Values.
static DataManipulator.Immutable	immutableOf(ValueContainer valueContainer)	Creates an DataManipulator.Immutable view directly based on the Values provided by the given ValueContainer, such that all ValueContainer.getValues() will be converted via Value.asImmutable() and constructed into an DataManipulator.Immutable.
static DataManipulator.Mutable	mutableOf()	Creates an empty DataManipulator.Mutable manipulator that can be consumed, populated, and mutated at liberty.
static DataManipulator.Mutable	mutableOf(Iterable<? extends Value<?>> values)	Creates a new DataManipulator with the provided Values such that the resulting DataManipulator.Mutable will contain all said values.
static DataManipulator.Mutable	mutableOf(ValueContainer valueContainer)	Creates a new DataManipulator with all values retrievable through the given ValueContainer by ValueContainer.getValues() with the connotation that all Values are provided, even those that are not persisted or registered through a DataRegistration.

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

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

Method Details

immutableOf

static DataManipulator.Immutable immutableOf(Iterable<? extends Value<?>> values)

Creates a DataManipulator.Immutable view directly based on the Values. No unnecessary copies of the Values will be created.

Parameters:

values - The values

Returns:

The immutable data manipulator view

immutableOf

static DataManipulator.Immutable immutableOf(ValueContainer valueContainer)

Creates an DataManipulator.Immutable view directly based on the Values provided by the given ValueContainer, such that all ValueContainer.getValues() will be converted via Value.asImmutable() and constructed into an DataManipulator.Immutable.

Parameters:

valueContainer - The value container to populate values from

Returns:

The immutable manipulator

immutableOf

static DataManipulator.Immutable immutableOf()

Gets a empty DataManipulator.Immutable.

Returns:

The empty immutable data manipulator

mutableOf

static DataManipulator.Mutable mutableOf()

Creates an empty DataManipulator.Mutable manipulator that can be consumed, populated, and mutated at liberty.

Returns:

A new empty manipulator

mutableOf

static DataManipulator.Mutable mutableOf(Iterable<? extends Value<?>> values)

Creates a new DataManipulator with the provided Values such that the resulting DataManipulator.Mutable will contain all said values. The returned manipulator is still mutable.

Parameters:

values - The values to populate the mutable container

Returns:

The mutable manipulator containing all values

mutableOf

static DataManipulator.Mutable mutableOf(ValueContainer valueContainer)

Creates a new DataManipulator with all values retrievable through the given ValueContainer by ValueContainer.getValues() with the connotation that all Values are provided, even those that are not persisted or registered through a DataRegistration.

Parameters:

valueContainer - The value container providing all values

Returns:

The mutable manipulator containing all values

copy

DataManipulator 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

Returns:

The new copy

asMutableCopy

DataManipulator.Mutable asMutableCopy()

Creates a new DataManipulator.Mutable copy of all Values contained in this DataManipulator, regardless whether this is a mutable instance already. Changes to this container will NOT persist to the copied instance. This is different from copy() as the copied instance may not be DataManipulator.Mutable.

Returns:

The copied instance

asMutable

DataManipulator.Mutable asMutable()

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

The cases where this DataManipulator is already a DataManipulator.Mutable, the same manipulator object is returned.

Returns:

This DataManipulator's data copied into a DataManipulator.Mutable

asImmutable

DataManipulator.Immutable asImmutable()

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.

Returns:

This DataManipulator's data copied into a DataManipulator.Immutable