nova.core.retention

Class Data

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<java.lang.String,java.lang.Object>

nova.core.retention.Data

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public class Data
extends java.util.HashMap<java.lang.String,java.lang.Object>

The data class is capable of storing named data.

Data types supported:
- Boolean
- Byte
- Short
- Integer
- Long
- Character
- Float
- Double
- String

- BigInteger
- BigDecimal
- Enumerator
- Storable (Converted into Data)
- Data
- Collection (Converted into Data)
- Vector3D
- Vector2D
- Class
- UUID

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	className
static java.lang.Class<?>[]	dataTypes
static java.util.regex.Pattern	ILLEGAL_SUFFIX The pattern denoting the illegal suffix for keys.

Constructor Summary

Constructors

Constructor and Description
Data()
Data(java.lang.Class<?> clazz)

Method Summary

Modifier and Type	Method and Description
static Data	fromJSON(javax.json.stream.JsonParser reader)
static Data	fromJSON(java.lang.String string)
<T> T	get(java.lang.String key) A pre-cast version of get.
<T> java.lang.Class<T>	getClass(java.lang.String key)
<T> java.util.List<T>	getCollection(java.lang.String key)
<T extends java.lang.Enum<T>> T	getEnum(java.lang.String key)
<T extends Storable> T	getStorable(java.lang.String key)
java.util.UUID	getUUID(java.lang.String key)
org.apache.commons.math3.geometry.euclidean.twod.Vector2D	getVector2D(java.lang.String key)
org.apache.commons.math3.geometry.euclidean.threed.Vector3D	getVector3D(java.lang.String key)
java.lang.Object	put(java.lang.String key, java.lang.Object value)
void	putAll(Data m)
void	putAll(java.util.Map<? extends java.lang.String,?> m)
static Data	serialize(java.lang.Object value) Saves an object, serializing its data.
static Data	serialize(Storable storable) Saves an object, serializing its data.
java.lang.String	toJson()
static java.lang.String	toJSON(Data data)
static void	toJSON(Data data, javax.json.stream.JsonGenerator writer)
void	toJson(javax.json.stream.JsonGenerator writer)
static <T extends Storable> T	unserialize(java.lang.Class<T> clazz, Data data) Loads an object from its stored data, given its class.
static <T> T	unserialize(Data data) Loads an object from its stored data, with an unknown class.

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

dataTypes

public static java.lang.Class<?>[] dataTypes

ILLEGAL_SUFFIX

public static final java.util.regex.Pattern ILLEGAL_SUFFIX

The pattern denoting the illegal suffix for keys. It is reserved for NOVA wrapper uses.

className

public java.lang.String className

Constructor Detail

Data

public Data()

Data

public Data(java.lang.Class<?> clazz)

Method Detail

serialize

public static Data serialize(Storable storable)

Saves an object, serializing its data. This map can be reloaded and its class with be reconstructed.

Parameters:

storable - - The object to store.

Returns:

The data of the object.

serialize

public static Data serialize(java.lang.Object value)

Saves an object, serializing its data. This map can be reloaded and its class with be reconstructed.

Parameters:

value - - The object to store.

Returns:

The data of the object.

unserialize

public static <T> T unserialize(Data data)

Loads an object from its stored data, with an unknown class. The class of the object must be stored within the data.

Type Parameters:

T - - The object type

Parameters:

data - - The data

Returns:

The object loaded with given data.

unserialize

public static <T extends Storable> T unserialize(java.lang.Class<T> clazz,
                                                 Data data)

Loads an object from its stored data, given its class.

Type Parameters:

T - - The type

Parameters:

clazz - - The class to load

data - - The data

Returns:

The object loaded with given data.

putAll

public void putAll(java.util.Map<? extends java.lang.String,?> m)

Specified by:

putAll in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

putAll in class java.util.HashMap<java.lang.String,java.lang.Object>

putAll

public void putAll(Data m)

put

public java.lang.Object put(java.lang.String key,
                            java.lang.Object value)

Specified by:

put in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

put in class java.util.HashMap<java.lang.String,java.lang.Object>

get

public <T> T get(java.lang.String key)

A pre-cast version of get.

Type Parameters:

T - - The type

Parameters:

key - - The key

Returns:

The value

getEnum

public <T extends java.lang.Enum<T>> T getEnum(java.lang.String key)

getVector3D

public org.apache.commons.math3.geometry.euclidean.threed.Vector3D getVector3D(java.lang.String key)

getVector2D

public org.apache.commons.math3.geometry.euclidean.twod.Vector2D getVector2D(java.lang.String key)

getStorable

public <T extends Storable> T getStorable(java.lang.String key)

getCollection

public <T> java.util.List<T> getCollection(java.lang.String key)

getClass

public <T> java.lang.Class<T> getClass(java.lang.String key)

getUUID

public java.util.UUID getUUID(java.lang.String key)

toJson

public void toJson(javax.json.stream.JsonGenerator writer)

toJson

public java.lang.String toJson()

toJSON

public static void toJSON(Data data,
                          javax.json.stream.JsonGenerator writer)

toJSON

public static java.lang.String toJSON(Data data)

fromJSON

public static Data fromJSON(javax.json.stream.JsonParser reader)

fromJSON

public static Data fromJSON(java.lang.String string)