Package org.spongepowered.api.data

Interface DataManipulator.Mutable

All Superinterfaces:

CopyableValueContainer, DataManipulator, ValueContainer

Enclosing interface:

DataManipulator

public static interface DataManipulator.Mutable
extends DataManipulator

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	DataManipulator.Mutable.Factory	A factory to create new DataManipulator.Mutable manipulators.

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

DataManipulator.Immutable, DataManipulator.Mutable

Method Summary

Modifier and Type	Method	Description
default 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	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 DataManipulator.Mutable	copyFrom(ValueContainer valueContainer)	Attempts to read data from the given ValueContainer and fills the associated data onto this DataManipulator.Mutable.
default DataManipulator.Mutable	copyFrom(ValueContainer valueContainer, java.lang.Iterable<Key<?>> keys)	Attempts to read data from the given ValueContainer and fills the associated data onto this DataManipulator.Mutable.
default DataManipulator.Mutable	copyFrom(ValueContainer valueContainer, java.util.function.Predicate<Key<?>> predicate)	Attempts to read data from the given ValueContainer and fills the associated data onto this DataManipulator.Mutable.
default DataManipulator.Mutable	copyFrom(ValueContainer valueContainer, Key<?> first, Key<?>... more)	Attempts to read data from the given ValueContainer and fills the associated data onto this DataManipulator.Mutable.
DataManipulator.Mutable	copyFrom(ValueContainer valueContainer, MergeFunction overlap)	Attempts to read data from the given ValueContainer and fills the associated data onto this DataManipulator.Mutable.
DataManipulator.Mutable	copyFrom(ValueContainer valueContainer, MergeFunction overlap, java.lang.Iterable<Key<?>> keys)	Attempts to read data from the given ValueContainer and fills the associated data onto this DataManipulator.Mutable.
DataManipulator.Mutable	copyFrom(ValueContainer valueContainer, MergeFunction overlap, java.util.function.Predicate<Key<?>> predicate)	Attempts to read data from the given ValueContainer and fills the associated data onto this DataManipulator.Mutable.
default DataManipulator.Mutable	copyFrom(ValueContainer valueContainer, MergeFunction overlap, Key<?> first, Key<?>... more)	Attempts to read data from the given ValueContainer and fills the associated data onto this DataManipulator.Mutable.
DataManipulator.Mutable	remove(Key<?> key)
default DataManipulator.Mutable	set(java.lang.Iterable<? extends Value<?>> values)	Sets the supported Values onto this DataManipulator.Mutable.
default <E,V extends Value<E>> DataManipulator.Mutable	set(java.util.function.Supplier<Key<V>> key, E value)
default <E,V extends Value<E>> DataManipulator.Mutable	set(java.util.function.Supplier<Key<V>> key, java.util.function.Supplier<E> value)
<E> DataManipulator.Mutable	set(Key<? extends Value<E>> key, E value)	Sets the supported Key's value such that the value is set on this DataManipulator.Mutable without having to directly set the Value.Mutable and set(Value) afterwards.
default DataManipulator.Mutable	set(Value<?> value)	Sets the supported Value onto this DataManipulator.Mutable.
default DataManipulator.Mutable	set(Value<?>... values)	Sets the supported Values onto this DataManipulator.Mutable.
default <E> DataManipulator.Mutable	transform(Key<? extends Value<E>> key, java.util.function.Function<E,E> function)	Applies a transformation on the provided value if available.

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

asImmutable, 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

copyFrom

default DataManipulator.Mutable copyFrom(ValueContainer valueContainer,
                                         java.util.function.Predicate<Key<?>> predicate)

Attempts to read data from the given ValueContainer and fills the associated data onto this DataManipulator.Mutable. Only Keys that match the predicate will be copied.

Any data that overlaps existing data from the ValueContainer will take priority and be overwritten from the pre-existing data from the ValueContainer.

Parameters:

valueContainer - The ValueContainer to copy data from

predicate - The predicate to filter which keys can be copied

Returns:

This DataManipulator.Mutable with relevant data filled from the given ValueContainer

copyFrom

DataManipulator.Mutable copyFrom(ValueContainer valueContainer,
                                 MergeFunction overlap,
                                 java.util.function.Predicate<Key<?>> predicate)

Attempts to read data from the given ValueContainer and fills the associated data onto this DataManipulator.Mutable. Only Keys that match the predicate will be copied.

Any data that overlaps existing data from the ValueContainer will take priority and be overwritten from the pre-existing data from the ValueContainer.

Parameters:

valueContainer - The ValueContainer to copy data from

overlap - The overlap resolver to decide which value to retain

predicate - The predicate to filter which keys can be copied

Returns:

This DataManipulator.Mutable with relevant data filled from the given ValueContainer

copyFrom

default DataManipulator.Mutable copyFrom(ValueContainer valueContainer,
                                         Key<?> first,
                                         Key<?>... more)

Attempts to read data from the given ValueContainer and fills the associated data onto this DataManipulator.Mutable. Only the values of the provided Keys will be copied if present.

Any data that overlaps existing data from the ValueContainer will take priority and be overwritten from the pre-existing data from the ValueContainer.

Parameters:

valueContainer - The ValueContainer to copy data from

first - The first key to copy

more - The additional keys to copy

Returns:

This DataManipulator.Mutable with relevant data filled from the given ValueContainer

copyFrom

default DataManipulator.Mutable copyFrom(ValueContainer valueContainer,
                                         MergeFunction overlap,
                                         Key<?> first,
                                         Key<?>... more)

Attempts to read data from the given ValueContainer and fills the associated data onto this DataManipulator.Mutable. Only the values of the provided Keys will be copied if present. Any data that overlaps between this and the given DataHolder will be resolved using the given MergeFunction.

Any data that overlaps existing data from the ValueContainer will take priority and be overwritten from the pre-existing data from the ValueContainer.

Parameters:

valueContainer - The ValueContainer to copy data from

overlap - The overlap resolver to decide which value to retain

first - The first key

more - The keys to copy

Returns:

This DataManipulator.Mutable with relevant data filled from the given ValueContainer

copyFrom

default DataManipulator.Mutable copyFrom(ValueContainer valueContainer,
                                         java.lang.Iterable<Key<?>> keys)

Attempts to read data from the given ValueContainer and fills the associated data onto this DataManipulator.Mutable. Only the values of the provided Keys will be copied if present.

Any data that overlaps existing data from the ValueContainer will take priority and be overwritten from the pre-existing data from the ValueContainer.

Parameters:

valueContainer - The ValueContainer to copy data from

keys - The keys to copy

Returns:

This DataManipulator.Mutable with relevant data filled from the given ValueContainer

copyFrom

DataManipulator.Mutable copyFrom(ValueContainer valueContainer,
                                 MergeFunction overlap,
                                 java.lang.Iterable<Key<?>> keys)

Attempts to read data from the given ValueContainer and fills the associated data onto this DataManipulator.Mutable. Only the values of the provided Keys will be copied if present. Any data that overlaps between this and the given DataHolder will be resolved using the given MergeFunction.

Any data that overlaps existing data from the ValueContainer will take priority and be overwritten from the pre-existing data from the ValueContainer.

Parameters:

valueContainer - The ValueContainer to copy data from

overlap - The overlap resolver to decide which value to retain

keys - The keys to copy

Returns:

This DataManipulator.Mutable with relevant data filled from the given ValueContainer

copyFrom

default DataManipulator.Mutable copyFrom(ValueContainer valueContainer)

Attempts to read data from the given ValueContainer and fills the associated data onto this DataManipulator.Mutable.

Any values that overlaps existing values from the ValueContainer will take priority and be overwritten from the pre-existing data from the ValueContainer.

Parameters:

valueContainer - The ValueContainer to extract data from

Returns:

This DataManipulator.Mutable with relevant data filled from the given DataHolder

copyFrom

DataManipulator.Mutable copyFrom(ValueContainer valueContainer,
                                 MergeFunction overlap)

Attempts to read data from the given ValueContainer and fills the associated data onto this DataManipulator.Mutable. Any data that overlaps between this and the given DataHolder will be resolved using the given MergeFunction.

Any values that overlaps existing values from the ValueContainer will take priority and be overwritten from the pre-existing data from the ValueContainer.

Parameters:

valueContainer - The ValueContainer to extract data from

overlap - The overlap resolver

Returns:

This DataManipulator.Mutable with relevant data filled from the given DataHolder

set

<E> DataManipulator.Mutable set(Key<? extends Value<E>> key,
                                E value)

Sets the supported Key's value such that the value is set on this DataManipulator.Mutable without having to directly set the Value.Mutable and set(Value) afterwards. The requirement for this to succeed is that the Key must be checked that it is supported via ValueContainer.supports(Value) or ValueContainer.supports(Key) otherwise an IllegalArgumentException may be thrown. For fluency, after setting, this DataManipulator.Mutable is returned.

Type Parameters:

E - The type of value

Parameters:

key - The key of the value to set

value - The actual value to set

Returns:

This manipulator, for chaining

set

default <E,V extends Value<E>> DataManipulator.Mutable set(java.util.function.Supplier<Key<V>> key,
                                                                 E value)

set

default <E,V extends Value<E>> DataManipulator.Mutable set(java.util.function.Supplier<Key<V>> key,
                                                                 java.util.function.Supplier<E> value)

set

default DataManipulator.Mutable set(Value<?> value)

Sets the supported Value onto this DataManipulator.Mutable. The requirement for this to succeed is that the Value is checked for support via ValueContainer.supports(Value) or ValueContainer.supports(Key) otherwise an IllegalArgumentException may be thrown. For fluency, after setting, this DataManipulator.Mutable is returned.

Parameters:

value - The actual value to set

Returns:

This manipulator, for chaining

set

default DataManipulator.Mutable set(Value<?>... values)

Sets the supported Values onto this DataManipulator.Mutable. The requirement for this to succeed is that the Value is checked for support via ValueContainer.supports(Value) or ValueContainer.supports(Key) otherwise an IllegalArgumentException may be thrown. For fluency, after setting, this DataManipulator.Mutable is returned.

Parameters:

values - The actual values to set

Returns:

This manipulator, for chaining

set

default DataManipulator.Mutable set(java.lang.Iterable<? extends Value<?>> values)

Sets the supported Values onto this DataManipulator.Mutable. The requirement for this to succeed is that the Value is checked for support via ValueContainer.supports(Value) or ValueContainer.supports(Key) otherwise an IllegalArgumentException may be thrown. For fluency, after setting, this DataManipulator.Mutable is returned.

Parameters:

values - The actual values to set

Returns:

This manipulator, for chaining

transform

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

Applies a transformation on the provided value if available. This is the same as DataHolder.Mutable.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

remove

DataManipulator.Mutable remove(Key<?> key)

asMutable

default DataManipulator.Mutable asMutable()

Description copied from interface: DataManipulator

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.

Specified by:

asMutable in interface DataManipulator

Returns:

This DataManipulator's data copied into a DataManipulator.Mutable

copy

DataManipulator.Mutable 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