org.spongepowered.api.data

Interface DataContainer

All Superinterfaces:

DataView

All Known Implementing Classes:

MemoryDataContainer

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.DataView

DataView.SafetyMode

Method Summary

Modifier and Type	Method and 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.
DataContainer	set(DataQuery path, Object value) Sets the given Object value according to the given path relative to this DataView's path.
<E> DataContainer	set(Key<? extends BaseValue<E>> key, E value) Sets the given Keyed value according to the provided Key's Key.getQuery().

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

contains, contains, contains, contains, copy, copy, createView, createView, get, getBoolean, getBooleanList, getByte, getByteList, getCatalogType, getCatalogTypeList, getCharacterList, getContainer, getCurrentPath, getDouble, getDoubleList, getFloat, getFloatList, getInt, getIntegerList, getKeys, getList, getLong, getLongList, getMap, getMapList, getName, getObject, getObjectList, getParent, getSafetyMode, getSerializable, getSerializableList, getShort, getShortList, getString, getStringList, getValues, getView, getViewList, isEmpty

Method Detail

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

<E> DataContainer set(Key<? extends BaseValue<E>> key,
                      E value)

Description copied from interface: DataView

Sets the given Keyed value according to the provided Key's Key.getQuery().

Specified by:

set in interface DataView

Type Parameters:

E - The type of value

Parameters:

key - The key of the value 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