org.spongepowered.api.data

Class MemoryDataView

java.lang.Object

org.spongepowered.api.data.MemoryDataView

All Implemented Interfaces:

DataView

Direct Known Subclasses:

MemoryDataContainer

Deprecated.

To be moved to implementation to avoid implementation bugs being existing in the API.

@Deprecated
public class MemoryDataView
extends Object
implements DataView

Default implementation of a DataView being used in memory.

Nested Class Summary

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

DataView.SafetyMode

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	map Deprecated.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MemoryDataView(DataView.SafetyMode safety) Deprecated.
protected	MemoryDataView(DataView parent, DataQuery path, DataView.SafetyMode safety) Deprecated.

Method Summary

Modifier and Type	Method and Description
boolean	contains(DataQuery path) Deprecated. Returns whether this DataView contains the given path.
boolean	contains(DataQuery path, DataQuery... paths) Deprecated. Returns whether this DataView contains an entry for all provided DataQuery objects.
DataContainer	copy() Deprecated. Copies this DataView and all of it's contents into a new DataContainer.
DataContainer	copy(DataView.SafetyMode safety) Deprecated. Copies this DataView and all of it's contents into a new DataContainer with the given safety mode.
DataView	createView(DataQuery path) Deprecated. Creates a new DataView at the desired path.
DataView	createView(DataQuery path, Map<?,?> map) Deprecated. Creates a new DataView with the given data at the desired path.
boolean	equals(Object obj) Deprecated.
Optional<Object>	get(DataQuery path) Deprecated. Gets an object from the desired path.
Optional<Boolean>	getBoolean(DataQuery path) Deprecated. Gets the Boolean by path, if available.
Optional<List<Boolean>>	getBooleanList(DataQuery path) Deprecated. Gets the List of Boolean by path, if available.
Optional<Byte>	getByte(DataQuery path) Deprecated. Gets the Byte by path, if available.
Optional<List<Byte>>	getByteList(DataQuery path) Deprecated. Gets the List of Byte by path, if available.
<T extends CatalogType> Optional<T>	getCatalogType(DataQuery path, Class<T> catalogType) Deprecated. Gets the CatalogType object by path, if available.
<T extends CatalogType> Optional<List<T>>	getCatalogTypeList(DataQuery path, Class<T> catalogType) Deprecated. Gets the List of CatalogTypes by path, if available.
Optional<List<Character>>	getCharacterList(DataQuery path) Deprecated. Gets the List of Character by path, if available.
DataContainer	getContainer() Deprecated. Gets the parent container of this DataView.
DataQuery	getCurrentPath() Deprecated. Gets the current path of this DataView from its root DataContainer.
Optional<Double>	getDouble(DataQuery path) Deprecated. Gets the Double by path, if available.
Optional<List<Double>>	getDoubleList(DataQuery path) Deprecated. Gets the List of Double by path, if available.
Optional<Float>	getFloat(DataQuery path) Deprecated. Gets the Float by path, if available.
Optional<List<Float>>	getFloatList(DataQuery path) Deprecated. Gets the List of Float by path, if available.
Optional<Integer>	getInt(DataQuery path) Deprecated. Gets the Integer by path, if available.
Optional<List<Integer>>	getIntegerList(DataQuery path) Deprecated. Gets the List of Integer by path, if available.
Set<DataQuery>	getKeys(boolean deep) Deprecated. Gets a collection containing all keys in this DataView.
Optional<List<?>>	getList(DataQuery path) Deprecated. Gets the List of something by path, if available.
Optional<Long>	getLong(DataQuery path) Deprecated. Gets the Long by path, if available.
Optional<List<Long>>	getLongList(DataQuery path) Deprecated. Gets the List of Long by path, if available.
Optional<? extends Map<?,?>>	getMap(DataQuery path) Deprecated. Gets the underlying Map by path, if available.
Optional<List<Map<?,?>>>	getMapList(DataQuery path) Deprecated. Gets the List of Map by path, if available.
String	getName() Deprecated. Gets the name of this individual DataView in the path.
<T> Optional<T>	getObject(DataQuery path, Class<T> objectClass) Deprecated. Gets the Object object by path, if available.
<T> Optional<List<T>>	getObjectList(DataQuery path, Class<T> objectClass) Deprecated. Gets the List of DataSerializable by path, if available.
Optional<DataView>	getParent() Deprecated. Gets the parent DataView of this view.
DataView.SafetyMode	getSafetyMode() Deprecated. Gets the DataView.SafetyMode of this data view.
<T extends DataSerializable> Optional<T>	getSerializable(DataQuery path, Class<T> clazz) Deprecated. Gets the DataSerializable object by path, if available.
<T extends DataSerializable> Optional<List<T>>	getSerializableList(DataQuery path, Class<T> clazz) Deprecated. Gets the List of DataSerializable by path, if available.
Optional<Short>	getShort(DataQuery path) Deprecated. Gets the Short by path, if available.
Optional<List<Short>>	getShortList(DataQuery path) Deprecated. Gets the List of Short by path, if available.
Optional<String>	getString(DataQuery path) Deprecated. Gets the String by path, if available.
Optional<List<String>>	getStringList(DataQuery path) Deprecated. Gets the List of String by path, if available.
Map<DataQuery,Object>	getValues(boolean deep) Deprecated. Gets a Map containing all keys and their values for this DataView.
Optional<DataView>	getView(DataQuery path) Deprecated. Gets the DataView by path, if available.
Optional<List<DataView>>	getViewList(DataQuery path) Deprecated. Gets the List of DataView by path, if available.
int	hashCode() Deprecated.
boolean	isEmpty() Deprecated. Gets if this view contains no data.
DataView	remove(DataQuery path) Deprecated. Removes the data associated to the given path relative to this DataView's path.
DataView	set(DataQuery path, Object value) Deprecated. Sets the given Object value according to the given path relative to this DataView's path.
<E> DataView	set(Key<? extends BaseValue<E>> key, E value) Deprecated. Sets the given Keyed value according to the provided Key's Key.getQuery().
String	toString() Deprecated.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

contains, contains

Field Detail

map

protected final Map<String,Object> map

Deprecated.

Constructor Detail

MemoryDataView

protected MemoryDataView(DataView.SafetyMode safety)

Deprecated.

MemoryDataView

protected MemoryDataView(DataView parent,
                         DataQuery path,
                         DataView.SafetyMode safety)

Deprecated.

Method Detail

getContainer

public DataContainer getContainer()

Deprecated.

Description copied from interface: DataView

Gets the parent container of this DataView.

Every DataView will always have a DataContainer.

For any DataContainer, this will return itself.

Specified by:

getContainer in interface DataView

Returns:

The parent container

getCurrentPath

public DataQuery getCurrentPath()

Deprecated.

Description copied from interface: DataView

Gets the current path of this DataView from its root DataContainer.

For any DataContainer itself, this will return an empty string as it is the root of the path.

The full path will always include this DataViews name at the end of the path.

Specified by:

getCurrentPath in interface DataView

Returns:

The path of this view originating from the root

getName

public String getName()

Deprecated.

Description copied from interface: DataView

Gets the name of this individual DataView in the path.

This will always be the final substring of the full path from DataView.getCurrentPath().

Specified by:

getName in interface DataView

Returns:

The name of this DataView

getParent

public Optional<DataView> getParent()

Deprecated.

Description copied from interface: DataView

Gets the parent DataView of this view. The parent directly contains this view according to the DataView.getCurrentPath().

For any DataContainer, this will return an absent parent.

Specified by:

getParent in interface DataView

Returns:

The parent data view containing this view

getKeys

public Set<DataQuery> getKeys(boolean deep)

Deprecated.

Description copied from interface: DataView

Gets a collection containing all keys in this DataView.

If deep is set to true, then this will contain all the keys within any child DataViews (and their children, etc). These will be in a valid path notation for you to use.

If deep is set to false, then this will contain only the keys of any direct children, and not their own children.

Specified by:

getKeys in interface DataView

Parameters:

deep - Whether or not to get all children keys

Returns:

A set of current keys in this container

getValues

public Map<DataQuery,Object> getValues(boolean deep)

Deprecated.

Description copied from interface: DataView

Gets a Map containing all keys and their values for this DataView.

If deep is set to true, then this will contain all the keys and values within any child DataViews (and their children, etc). These keys will be in a valid path notation for you to use.

If deep is set to false, then this will contain only the keys and values of any direct children, and not their own children.

Specified by:

getValues in interface DataView

Parameters:

deep - Whether or not to get a deep list of all children or not

Returns:

Map of keys and values of this container

contains

public final boolean contains(DataQuery path)

Deprecated.

Description copied from interface: DataView

Returns whether this DataView contains the given path.

Specified by:

contains in interface DataView

Parameters:

path - The path relative to this data view

Returns:

True if the path exists

contains

public boolean contains(DataQuery path,
                        DataQuery... paths)

Deprecated.

Description copied from interface: DataView

Returns whether this DataView contains an entry for all provided DataQuery objects.

Specified by:

contains in interface DataView

Parameters:

path - The path relative to this data view

paths - The additional paths to check

Returns:

True if all paths exist

get

public Optional<Object> get(DataQuery path)

Deprecated.

Description copied from interface: DataView

Gets an object from the desired path. If the path is not defined, an absent Optional is returned.

Specified by:

get in interface DataView

Parameters:

path - The path to the Object

Returns:

The Object, if available

set

public DataView set(DataQuery path,
                    Object value)

Deprecated.

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

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

Deprecated.

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

public DataView remove(DataQuery path)

Deprecated.

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

createView

public DataView createView(DataQuery path)

Deprecated.

Description copied from interface: DataView

Creates a new DataView at the desired path.

If any data existed at the given path, that data will be overwritten with the newly constructed DataView.

Specified by:

createView in interface DataView

Parameters:

path - The path of the new view

Returns:

The newly created view

createView

public DataView createView(DataQuery path,
                           Map<?,?> map)

Deprecated.

Description copied from interface: DataView

Creates a new DataView with the given data at the desired path.

If any data existed at the given path, that data will be overwritten with the newly constructed DataView.

Specified by:

createView in interface DataView

Parameters:

path - The path of the new view

map - The data to store in the new view

Returns:

The new view

getView

public Optional<DataView> getView(DataQuery path)

Deprecated.

Description copied from interface: DataView

Gets the DataView by path, if available.

If a DataView does not exist, or the data residing at the path is not an instance of a DataView, an absent is returned.

Specified by:

getView in interface DataView

Parameters:

path - The path of the value to get

Returns:

The data view, if available

getMap

public Optional<? extends Map<?,?>> getMap(DataQuery path)

Deprecated.

Description copied from interface: DataView

Gets the underlying Map by path, if available.

If a Map does not exist, or data residing at the path is not an instance of a Map, an absent is returned.

Specified by:

getMap in interface DataView

Parameters:

path - The path of the value to get

Returns:

The map, if available

getBoolean

public Optional<Boolean> getBoolean(DataQuery path)

Deprecated.

Description copied from interface: DataView

Gets the Boolean by path, if available.

If a Boolean does not exist, or the data residing at the path is not an instance of a Boolean, an absent is returned.

Specified by:

getBoolean in interface DataView

Parameters:

path - The path of the value to get

Returns:

The boolean, if available

getByte

public Optional<Byte> getByte(DataQuery path)

Deprecated.

Description copied from interface: DataView

Gets the Byte by path, if available.

If a Byte does not exist, or the data residing at the path is not an instance of a Byte, an absent is returned.

Specified by:

getByte in interface DataView

Parameters:

path - The path of the value to get

Returns:

The boolean, if available

getShort

public Optional<Short> getShort(DataQuery path)

Deprecated.

Description copied from interface: DataView

Gets the Short by path, if available.

If a Short does not exist, or the data residing at the path is not an instance of a Short, an absent is returned.

Specified by:

getShort in interface DataView

Parameters:

path - The path of the value to get

Returns:

The boolean, if available

getInt

public Optional<Integer> getInt(DataQuery path)

Deprecated.

Description copied from interface: DataView

Gets the Integer by path, if available.

If a Integer does not exist, or the data residing at the path is not an instance of a Integer, an absent is returned.

Specified by:

getInt in interface DataView

Parameters:

path - The path of the value to get

Returns:

The integer, if available

getLong

public Optional<Long> getLong(DataQuery path)

Deprecated.

Description copied from interface: DataView

Gets the Long by path, if available.

If a Long does not exist, or the data residing at the path is not an instance of a Long, an absent is returned.

Specified by:

getLong in interface DataView

Parameters:

path - The path of the value to get

Returns:

The long, if available

getFloat

public Optional<Float> getFloat(DataQuery path)

Deprecated.

Description copied from interface: DataView

Gets the Float by path, if available.

If a Float does not exist, or the data residing at the path is not an instance of a Float, an absent is returned.

Specified by:

getFloat in interface DataView

Parameters:

path - The path of the value to get

Returns:

The boolean, if available

getDouble

public Optional<Double> getDouble(DataQuery path)

Deprecated.

Description copied from interface: DataView

Gets the Double by path, if available.

If a Double does not exist, or the data residing at the path is not an instance of a Double, an absent is returned.

Specified by:

getDouble in interface DataView

Parameters:

path - The path of the value to get

Returns:

The double, if available

getString

public Optional<String> getString(DataQuery path)

Deprecated.

Description copied from interface: DataView

Gets the String by path, if available.

If a String does not exist, or the data residing at the path is not an instance of a String, an absent is returned.

Specified by:

getString in interface DataView

Parameters:

path - The path of the value to get

Returns:

The string, if available

getList

public Optional<List<?>> getList(DataQuery path)

Deprecated.

Description copied from interface: DataView

Gets the List of something by path, if available.

If a List of something does not exist, or the data residing at the path is not an instance of a List of something, an absent is returned.

Specified by:

getList in interface DataView

Parameters:

path - The path of the value to get

Returns:

The list, if available

getStringList

public Optional<List<String>> getStringList(DataQuery path)

Deprecated.

Description copied from interface: DataView

Gets the List of String by path, if available.

If a List of String does not exist, or the data residing at the path is not an instance of a List of String, an absent is returned.

Specified by:

getStringList in interface DataView

Parameters:

path - The path of the value to get

Returns:

The list of strings, if available

getCharacterList

public Optional<List<Character>> getCharacterList(DataQuery path)

Deprecated.

Description copied from interface: DataView

Gets the List of Character by path, if available.

If a List of Character does not exist, or the data residing at the path is not an instance of a List of Character, an absent is returned.

Specified by:

getCharacterList in interface DataView

Parameters:

path - The path of the value to get

Returns:

The list of characters, if available

getBooleanList

public Optional<List<Boolean>> getBooleanList(DataQuery path)

Deprecated.

Description copied from interface: DataView

Gets the List of Boolean by path, if available.

If a List of Boolean does not exist, or the data residing at the path is not an instance of a List of Boolean, an absent is returned.

Specified by:

getBooleanList in interface DataView

Parameters:

path - The path of the value to get

Returns:

The list of booleans, if available

getByteList

public Optional<List<Byte>> getByteList(DataQuery path)

Deprecated.

Description copied from interface: DataView

Gets the List of Byte by path, if available.

If a List of Byte does not exist, or the data residing at the path is not an instance of a List of Byte, an absent is returned.

Specified by:

getByteList in interface DataView

Parameters:

path - The path of the value to get

Returns:

The list of bytes, if available

getShortList

public Optional<List<Short>> getShortList(DataQuery path)

Deprecated.

Description copied from interface: DataView

Gets the List of Short by path, if available.

If a List of Short does not exist, or the data residing at the path is not an instance of a List of Short, an absent is returned.

Specified by:

getShortList in interface DataView

Parameters:

path - The path of the value to get

Returns:

The list of shorts, if available

getIntegerList

public Optional<List<Integer>> getIntegerList(DataQuery path)

Deprecated.

Description copied from interface: DataView

Gets the List of Integer by path, if available.

If a List of Integer does not exist, or the data residing at the path is not an instance of a List of Integer, an absent is returned.

Specified by:

getIntegerList in interface DataView

Parameters:

path - The path of the value to get

Returns:

The list of integers, if available

getLongList

public Optional<List<Long>> getLongList(DataQuery path)

Deprecated.

Description copied from interface: DataView

Gets the List of Long by path, if available.

If a List of Long does not exist, or the data residing at the path is not an instance of a List of Long, an absent is returned.

Specified by:

getLongList in interface DataView

Parameters:

path - The path of the value to get

Returns:

The list of longs, if available

getFloatList

public Optional<List<Float>> getFloatList(DataQuery path)

Deprecated.

Description copied from interface: DataView

Gets the List of Float by path, if available.

If a List of Float does not exist, or the data residing at the path is not an instance of a List of Float, an absent is returned.

Specified by:

getFloatList in interface DataView

Parameters:

path - The path of the value to get

Returns:

The list of floats, if available

getDoubleList

public Optional<List<Double>> getDoubleList(DataQuery path)

Deprecated.

Description copied from interface: DataView

Gets the List of Double by path, if available.

If a List of Double does not exist, or the data residing at the path is not an instance of a List of Double, an absent is returned.

Specified by:

getDoubleList in interface DataView

Parameters:

path - The path of the value to get

Returns:

The list of doubles, if available

getMapList

public Optional<List<Map<?,?>>> getMapList(DataQuery path)

Deprecated.

Description copied from interface: DataView

Gets the List of Map by path, if available.

If a List of Map does not exist, or the data residing at the path is not an instance of a List of Map, an absent is returned.

Specified by:

getMapList in interface DataView

Parameters:

path - The path of the value to get

Returns:

The list of maps, if available

getViewList

public Optional<List<DataView>> getViewList(DataQuery path)

Deprecated.

Description copied from interface: DataView

Gets the List of DataView by path, if available.

If a List of DataView does not exist, or the data residing at the path is not an instance of a List of DataView, an absent is returned.

Specified by:

getViewList in interface DataView

Parameters:

path - The path of the value to get

Returns:

The list of data views, if available

getSerializable

public <T extends DataSerializable> Optional<T> getSerializable(DataQuery path,
                                                                Class<T> clazz)

Deprecated.

Description copied from interface: DataView

Gets the DataSerializable object by path, if available.

If a DataSerializable exists, but is not the proper class type, or there is no data at the path given, an absent is returned.

It is important that the DataManager provided is the same one that has registered many of the DataBuilders to ensure the DataSerializable requested can be returned.

Specified by:

getSerializable in interface DataView

Type Parameters:

T - The type of DataSerializable object

Parameters:

path - The path of the value to get

clazz - The class of the DataSerializable

Returns:

The deserialized object, if available

getSerializableList

public <T extends DataSerializable> Optional<List<T>> getSerializableList(DataQuery path,
                                                                          Class<T> clazz)

Deprecated.

Description copied from interface: DataView

Gets the List of DataSerializable by path, if available.

If a List exists, but the contents of the list are not considered DataSerializable or are not of the proper type of DataSerializable, an absent is returned.

It is important that the DataManager provided is the same one that has registered many of the DataBuilders to ensure the DataSerializable requested can be returned.

Specified by:

getSerializableList in interface DataView

Type Parameters:

T - The type of DataSerializable object

Parameters:

path - The path of the list value to get

clazz - The class of the DataSerializable

Returns:

The deserialized objects in a list, if available

getCatalogType

public <T extends CatalogType> Optional<T> getCatalogType(DataQuery path,
                                                          Class<T> catalogType)

Deprecated.

Description copied from interface: DataView

Gets the CatalogType object by path, if available.

If a CatalogType exists, but is not named properly, not existing in a registry, or simply an invalid value will return an empty value.

Specified by:

getCatalogType in interface DataView

Type Parameters:

T - The type of dummy

Parameters:

path - The path of the value to get

catalogType - The class of the dummy type

Returns:

The dummy type, if available

getCatalogTypeList

public <T extends CatalogType> Optional<List<T>> getCatalogTypeList(DataQuery path,
                                                                    Class<T> catalogType)

Deprecated.

Description copied from interface: DataView

Gets the List of CatalogTypes by path, if available.

If a List exists, but contents of the list are not considered CatalogTypes or are not of the proper type of CatalogType, an absent is returned.

Specified by:

getCatalogTypeList in interface DataView

Type Parameters:

T - The type of dummy type

Parameters:

path - The path of the list value to get

catalogType - The class of the dummy type

Returns:

The list of dummy types, if available

getObject

public <T> Optional<T> getObject(DataQuery path,
                                 Class<T> objectClass)

Deprecated.

Description copied from interface: DataView

Gets the Object object by path, if available.

If a Object exists, but is not the proper class type, or there is no data at the path given, an absent is returned.

It is important that the DataManager provided is the same one that has registered many of the DataTranslators to ensure the DataSerializable requested can be returned.

Specified by:

getObject in interface DataView

Type Parameters:

T - The type of Object object

Parameters:

path - The path of the value to get

objectClass - The class of the Object

Returns:

The deserialized object, if available

getObjectList

public <T> Optional<List<T>> getObjectList(DataQuery path,
                                           Class<T> objectClass)

Deprecated.

Description copied from interface: DataView

Gets the List of DataSerializable by path, if available.

If a List exists, but the contents of the list are not considered DataTranslator"able" or are not of the proper type of DataTranslator, an absent is returned.

It is important that the DataManager provided is the same one that has registered many of the DataTranslators to ensure the Object requested can be returned.

Specified by:

getObjectList in interface DataView

Type Parameters:

T - The type of Object object

Parameters:

path - The path of the value to get

objectClass - The class of the Object

Returns:

The deserialized objects in a list, if available

copy

public DataContainer copy()

Deprecated.

Description copied from interface: DataView

Copies this DataView and all of it's contents into a new DataContainer.

Note that the copy will not have the same path as this DataView since it will be constructed with the top level path being itself.

Specified by:

copy in interface DataView

Returns:

The newly constructed data view

copy

public DataContainer copy(DataView.SafetyMode safety)

Deprecated.

Description copied from interface: DataView

Copies this DataView and all of it's contents into a new DataContainer with the given safety mode.

Note that the copy will not have the same path as this DataView since it will be constructed with the top level path being itself.

Specified by:

copy in interface DataView

Parameters:

safety - The safety mode of the copy

Returns:

The newly constructed data view

isEmpty

public boolean isEmpty()

Deprecated.

Description copied from interface: DataView

Gets if this view contains no data.

Specified by:

isEmpty in interface DataView

Returns:

True if no data

getSafetyMode

public DataView.SafetyMode getSafetyMode()

Deprecated.

Description copied from interface: DataView

Gets the DataView.SafetyMode of this data view.

Specified by:

getSafetyMode in interface DataView

Returns:

The safety mode

hashCode

public int hashCode()

Deprecated.

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable
                      Object obj)

Deprecated.

Overrides:

equals in class Object

toString

public String toString()

Deprecated.

Overrides:

toString in class Object