Package org.spongepowered.api.data.persistence

Interface DataContainer

All Superinterfaces:

DataView

public interface DataContainer
extends DataView

Represents a data structure that contains data. A DataContainer is an object that can be considered a root DataView.

Nested Class Summary

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

DataView.SafetyMode

Method Summary

Modifier and Type	Method	Description
static DataContainer	createNew()	Creates a new DataContainer with a default DataView.SafetyMode of DataView.SafetyMode.ALL_DATA_CLONED.
static DataContainer	createNew(DataView.SafetyMode safety)	Creates a new DataContainer with the provided DataView.SafetyMode.
DataContainer	remove(DataQuery path)	Removes the data associated to the given path relative to this DataView's path.
default DataContainer	set(String key, boolean value)	Sets the given boolean value to this DataView's key.
default DataContainer	set(String key, byte value)	Sets the given byte value to this DataView's key.
default DataContainer	set(String key, double value)	Sets the given double value to this DataView's key.
default DataContainer	set(String key, float value)	Sets the given float value to this DataView's key.
default DataContainer	set(String key, int value)	Sets the given int value to this DataView's key.
default DataContainer	set(String key, long value)	Sets the given long value to this DataView's key.
default DataContainer	set(String key, short value)	Sets the given short value to this DataView's key.
default DataContainer	set(String key, Object value)	Sets the given Object value to this DataView's key.
default DataContainer	set(String key, String value)	Sets the given String value to this DataView's key.
default DataContainer	set(DataQuery path, boolean value)	Sets the given boolean value according to the given path relative to this DataView's path.
default DataContainer	set(DataQuery path, byte value)	Sets the given byte value according to the given path relative to this DataView's path.
default DataContainer	set(DataQuery path, double value)	Sets the given double value according to the given path relative to this DataView's path.
default DataContainer	set(DataQuery path, float value)	Sets the given float value according to the given path relative to this DataView's path.
default DataContainer	set(DataQuery path, int value)	Sets the given int value according to the given path relative to this DataView's path.
default DataContainer	set(DataQuery path, long value)	Sets the given long value according to the given path relative to this DataView's path.
default DataContainer	set(DataQuery path, short value)	Sets the given short value according to the given path relative to this DataView's path.
DataContainer	set(DataQuery path, Object value)	Sets the given Object value according to the given path relative to this DataView's path.
default DataContainer	set(DataQuery path, String value)	Sets the given String value according to the given path relative to this DataView's path.

Methods inherited from interface org.spongepowered.api.data.persistence.DataView

container, contains, contains, copy, copy, createView, createView, createView, currentPath, get, getBoolean, getBooleanList, getByte, getByteList, getCharacterList, getDataKey, getDataKeyList, getDouble, getDoubleList, getFloat, getFloatList, getInt, getIntegerList, getList, getLong, getLongList, getMap, getMapList, getObject, getObjectList, getRegistryValue, getRegistryValue, getRegistryValueList, getRegistryValueList, getResourceKey, getResourceKeyList, getSerializable, getSerializableList, getShort, getShortList, getString, getStringList, getView, getView, getViewList, isEmpty, keys, name, parent, safetyMode, streamRootKeys, streamRootValues, values

Method Details

createNew

static DataContainer createNew()

Creates a new DataContainer with a default DataView.SafetyMode of DataView.SafetyMode.ALL_DATA_CLONED.

Returns:

A new data container

createNew

static DataContainer createNew(DataView.SafetyMode safety)

Creates a new DataContainer with the provided DataView.SafetyMode.

Parameters:

safety - The safety mode to use

Returns:

A new data container with the provided safety mode

See Also:

• DataView.SafetyMode

set

DataContainer set(DataQuery path,
 Object value)

Description copied from interface: DataView

Sets the given Object value according to the given path relative to this DataView's path.

Specified by:

set in interface DataView

Parameters:

path - The path of the object to set

value - The value of the data

Returns:

This view, for chaining

set

default DataContainer set(DataQuery path,
 String value)

Description copied from interface: DataView

Sets the given String value according to the given path relative to this DataView's path.

Specified by:

set in interface DataView

Parameters:

path - The path of the string to set

value - The value of the data

Returns:

This view, for chaining

set

default DataContainer set(DataQuery path,
 boolean value)

Description copied from interface: DataView

Sets the given boolean value according to the given path relative to this DataView's path.

Specified by:

set in interface DataView

Parameters:

path - The path of the boolean to set

value - The value of the data

Returns:

This view, for chaining

set

default DataContainer set(DataQuery path,
 byte value)

Description copied from interface: DataView

Sets the given byte value according to the given path relative to this DataView's path.

Specified by:

set in interface DataView

Parameters:

path - The path of the byte to set

value - The value of the data

Returns:

This view, for chaining

set

default DataContainer set(DataQuery path,
 short value)

Description copied from interface: DataView

Sets the given short value according to the given path relative to this DataView's path.

Specified by:

set in interface DataView

Parameters:

path - The path of the short to set

value - The value of the data

Returns:

This view, for chaining

set

default DataContainer set(DataQuery path,
 int value)

Description copied from interface: DataView

Sets the given int value according to the given path relative to this DataView's path.

Specified by:

set in interface DataView

Parameters:

path - The path of the int to set

value - The value of the data

Returns:

This view, for chaining

set

default DataContainer set(DataQuery path,
 long value)

Description copied from interface: DataView

Sets the given long value according to the given path relative to this DataView's path.

Specified by:

set in interface DataView

Parameters:

path - The path of the long to set

value - The value of the data

Returns:

This view, for chaining

set

default DataContainer set(DataQuery path,
 float value)

Description copied from interface: DataView

Sets the given float value according to the given path relative to this DataView's path.

Specified by:

set in interface DataView

Parameters:

path - The path of the float to set

value - The value of the data

Returns:

This view, for chaining

set

default DataContainer set(DataQuery path,
 double value)

Description copied from interface: DataView

Sets the given double value according to the given path relative to this DataView's path.

Specified by:

set in interface DataView

Parameters:

path - The path of the double to set

value - The value of the data

Returns:

This view, for chaining

set

default DataContainer set(String key,
 Object value)

Description copied from interface: DataView

Sets the given Object value to this DataView's key.

Specified by:

set in interface DataView

Parameters:

key - The key of the object to set

value - The value of the data

Returns:

This view, for chaining

set

default DataContainer set(String key,
 String value)

Description copied from interface: DataView

Sets the given String value to this DataView's key.

Specified by:

set in interface DataView

Parameters:

key - The key of the object to set

value - The value of the data

Returns:

This view, for chaining

set

default DataContainer set(String key,
 boolean value)

Description copied from interface: DataView

Sets the given boolean value to this DataView's key.

Specified by:

set in interface DataView

Parameters:

key - The key of the object to set

value - The value of the data

Returns:

This view, for chaining

set

default DataContainer set(String key,
 byte value)

Description copied from interface: DataView

Sets the given byte value to this DataView's key.

Specified by:

set in interface DataView

Parameters:

key - The key of the object to set

value - The value of the data

Returns:

This view, for chaining

set

default DataContainer set(String key,
 short value)

Description copied from interface: DataView

Sets the given short value to this DataView's key.

Specified by:

set in interface DataView

Parameters:

key - The key of the object to set

value - The value of the data

Returns:

This view, for chaining

set

default DataContainer set(String key,
 int value)

Description copied from interface: DataView

Sets the given int value to this DataView's key.

Specified by:

set in interface DataView

Parameters:

key - The key of the object to set

value - The value of the data

Returns:

This view, for chaining

set

default DataContainer set(String key,
 long value)

Description copied from interface: DataView

Sets the given long value to this DataView's key.

Specified by:

set in interface DataView

Parameters:

key - The key of the object to set

value - The value of the data

Returns:

This view, for chaining

set

default DataContainer set(String key,
 float value)

Description copied from interface: DataView

Sets the given float value to this DataView's key.

Specified by:

set in interface DataView

Parameters:

key - The key of the object to set

value - The value of the data

Returns:

This view, for chaining

set

default DataContainer set(String key,
 double value)

Description copied from interface: DataView

Sets the given double value to this DataView's key.

Specified by:

set in interface DataView

Parameters:

key - The key of the object to set

value - The value of the data

Returns:

This view, for chaining

remove

DataContainer remove(DataQuery path)

Description copied from interface: DataView

Removes the data associated to the given path relative to this DataView's path.

Path can not be empty, to remove this DataView, call the associated parent to remove this views name.

Specified by:

remove in interface DataView

Parameters:

path - The path of data to remove

Returns:

This view, for chaining