heronarts.lx

Class LXSerializable.Utils

java.lang.Object

heronarts.lx.LXSerializable.Utils

Enclosing interface:

LXSerializable

public static class LXSerializable.Utils
extends Object

Static container for utility methods

Constructor Summary

Constructors

Constructor and Description
Utils()

Method Summary

Modifier and Type	Method and Description
static void	loadArray(LX lx, List<? extends LXSerializable> serializables, JsonObject object, String key) Loads an array of sub-objects from the given key, if it is found
static void	loadArray(LX lx, LXSerializable[] serializables, JsonObject object, String key) Loads an array of sub-objects from the given key, if it is found
static void	loadBoolean(BooleanParameter parameter, JsonObject object, String key) Loads a boolean value into a parameter, if it is found.
static void	loadDouble(LXParameter parameter, JsonObject object, String key) Loads an double value into a parameter, if it is found.
static void	loadInt(DiscreteParameter parameter, JsonObject object, String key) Loads an integer value into a parameter, if it is found.
static void	loadObject(LX lx, LXSerializable serializable, JsonObject object, String key) Loads a serializable object from a sub-key, if the key is found.
static void	loadObject(LX lx, LXSerializable serializable, JsonObject object, String key, boolean defaultEmptyObj) Loads a serializable object from a sub-key, if the key is found.
static void	loadParameter(LXParameter parameter, JsonObject obj, String path)
static void	loadString(StringParameter parameter, JsonObject object, String key) Loads an double value into a parameter, if it is found.
static void	saveParameter(LXParameter parameter, JsonObject obj)
static void	saveParameter(LXParameter parameter, JsonObject obj, String path)
static JsonObject	stripIds(JsonObject object) Strips all ID values out of a JsonObject.
static JsonArray	toArray(LX lx, Collection<? extends LXSerializable> serializables) Serialized a generic collection of sub-objects, not necessarily ordered
static JsonArray	toArray(LX lx, LXSerializable[] serializables) Serializes an array of subobjects
static JsonObject	toObject(LXComponent component) Serializes an LXComponent to a JsonObject
static JsonObject	toObject(LX lx, LXSerializable serializable) Serializes any LXSerializable to a JsonObject
static JsonObject	toObject(LX lx, Map<String,? extends LXSerializable> serializables) Serializes a map of subobjects into a JsonObject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Utils

public Utils()

Method Detail

saveParameter

public static void saveParameter(LXParameter parameter,
                                 JsonObject obj)

saveParameter

public static void saveParameter(LXParameter parameter,
                                 JsonObject obj,
                                 String path)

loadParameter

public static void loadParameter(LXParameter parameter,
                                 JsonObject obj,
                                 String path)

loadInt

public static void loadInt(DiscreteParameter parameter,
                           JsonObject object,
                           String key)

Loads an integer value into a parameter, if it is found. If the key doesn't exist, this method does nothing.

Parameters:

parameter - Parameter to load

object - Json object

key - Key to check, if exists loaded as int

loadBoolean

public static void loadBoolean(BooleanParameter parameter,
                               JsonObject object,
                               String key)

Loads a boolean value into a parameter, if it is found. If the key doesn't exist, this method does nothing.

Parameters:

parameter - Parameter to load

object - Json object

key - Key to check, if exists loaded as boolean

loadDouble

public static void loadDouble(LXParameter parameter,
                              JsonObject object,
                              String key)

Loads an double value into a parameter, if it is found. If the key doesn't exist, this method does nothing.

Parameters:

parameter - Parameter to load

object - Json object

key - Key to check, if exists loaded as double

loadString

public static void loadString(StringParameter parameter,
                              JsonObject object,
                              String key)

Loads an double value into a parameter, if it is found. If the key doesn't exist, this method does nothing.

Parameters:

parameter - Parameter to load

object - Json object

key - Key to check, if exists loaded as string

loadObject

public static void loadObject(LX lx,
                              LXSerializable serializable,
                              JsonObject object,
                              String key)

Loads a serializable object from a sub-key, if the key is found. If it is not found, no loading will occur.

Parameters:

lx - LX instance

serializable - Sub-object to load

object - JSON object to load from

key - Key to check for existence of

loadObject

public static void loadObject(LX lx,
                              LXSerializable serializable,
                              JsonObject object,
                              String key,
                              boolean defaultEmptyObj)

Loads a serializable object from a sub-key, if the key is found. If it is not found, loading will occur with a default empty object if the final argument is true. The sub-object should handle that.

Parameters:

lx - LX instance

serializable - Sub-object to load

object - JSON object to load from

key - Key to check for existence of

defaultEmptyObj - Whether to load an empty JsonObject if key is not found

loadArray

public static void loadArray(LX lx,
                             List<? extends LXSerializable> serializables,
                             JsonObject object,
                             String key)

Loads an array of sub-objects from the given key, if it is found

Parameters:

lx - LX instance

serializables - List of child objects to load

object - Object to load from

key - Key to check for

loadArray

public static void loadArray(LX lx,
                             LXSerializable[] serializables,
                             JsonObject object,
                             String key)

Loads an array of sub-objects from the given key, if it is found

Parameters:

lx - LX instance

serializables - array of child objects to load

object - Object to load from

key - Key to check for

toObject

public static JsonObject toObject(LXComponent component)

Serializes an LXComponent to a JsonObject

Parameters:

component - Component to serialize

Returns:

JsonObject representation of the component

toObject

public static JsonObject toObject(LX lx,
                                  LXSerializable serializable)

Serializes any LXSerializable to a JsonObject

Parameters:

lx - LX instance

serializable - Serializable object

Returns:

JsonObject representation of the object

toObject

public static JsonObject toObject(LX lx,
                                  Map<String,? extends LXSerializable> serializables)

Serializes a map of subobjects into a JsonObject

Parameters:

lx - LX instance

serializables - Map of serializable subobjects

Returns:

JsonObject representation of all child objects

toArray

public static JsonArray toArray(LX lx,
                                LXSerializable[] serializables)

Serializes an array of subobjects

Parameters:

lx - LX instance

serializables - Array of sub-objects

Returns:

JsonArray representation of all subobjects

toArray

public static JsonArray toArray(LX lx,
                                Collection<? extends LXSerializable> serializables)

Serialized a generic collection of sub-objects, not necessarily ordered

Parameters:

lx - LX instance

serializables - Collection of serializable objects

Returns:

JsonArray representation of collection of objects

stripIds

public static JsonObject stripIds(JsonObject object)

Strips all ID values out of a JsonObject. This is often helpful when copy/pasting or loading objects in a context where global IDs should not be overwritten.

Parameters:

object - Object to strip all nested ID keys from

Returns:

The same object, with no ID keys