Class ObjectModel

java.lang.Object

com.blueriq.component.api.externalflow.data.ObjectModel

All Implemented Interfaces:

ObjectModelCreation, ObjectModelRetrieval, ObjectModelStorage

public class ObjectModel
extends Object
implements ObjectModelCreation, ObjectModelRetrieval, ObjectModelStorage

The ObjectModel is not thread-safe and should not be shared over multiple threads, unless the object is synchronized by the caller.

Constructor Summary

Constructors

Constructor	Description
ObjectModel()
ObjectModel(byte[] jsonBytesArray)	Construct an object model using byte array containing json.
ObjectModel(tools.jackson.databind.JsonNode jsonNode)

Method Summary

Modifier and Type	Method	Description
ArrayModelCreation	createArray(String key)	A function that creates a ArrayModelCreation and put is in the current ObjectModelCreation under the provided key.
ObjectModelCreation	createObject(String key)	A function that creates a ObjectModelCreation and put is in the current ObjectModelCreation under the provided key.
boolean	getBoolean(String property)
int	getInteger(String property)
ObjectModelRetrieval	getObject(String property)
Stream<ObjectModelRetrieval>	getObjectStream(String property)
Stream<String>	getProperties()
String	getString(String property)
String[]	getStringArray(String property)
List<String>	getStringList(String property)
Stream<String>	getStringStream(String property)
boolean	has(String key)
boolean	hasNonNull(String key)
boolean	isArray(String property)
boolean	isEmpty()
void	put(String key, boolean value)
void	put(String key, int value)
void	put(String key, String value)
void	putIfAbsent(String key, boolean value)
void	putIfAbsent(String key, int value)
void	putIfAbsent(String key, String value)
void	putIfAbsent(String key, Consumer<ObjectModelCreation> objectModelConsumer)	A function that creates a ObjectModelCreation and put is in the current ObjectModelCreation under the provided key when it isn't already set.
void	putNull(String key)
void	putNullIfAbsent(String key)
byte[]	toBytes()	A function that can be used to serialize the ObjectModelStorage to a byte array.

Methods inherited from class Object

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

Constructor Details

ObjectModel

public ObjectModel()

ObjectModel

public ObjectModel(byte[] jsonBytesArray)

Construct an object model using byte array containing json. The expected encoding should be UTF-8

Parameters:

jsonBytesArray - UTF-8 encoded json byte array

ObjectModel

public ObjectModel(tools.jackson.databind.JsonNode jsonNode)

Method Details

put

public void put(String key,
 String value)

Specified by:

put in interface ObjectModelCreation

put

public void put(String key,
 boolean value)

Specified by:

put in interface ObjectModelCreation

put

public void put(String key,
 int value)

Specified by:

put in interface ObjectModelCreation

putIfAbsent

public void putIfAbsent(String key,
 String value)

Specified by:

putIfAbsent in interface ObjectModelCreation

putIfAbsent

public void putIfAbsent(String key,
 boolean value)

Specified by:

putIfAbsent in interface ObjectModelCreation

putIfAbsent

public void putIfAbsent(String key,
 int value)

Specified by:

putIfAbsent in interface ObjectModelCreation

putIfAbsent

public void putIfAbsent(String key,
 Consumer<ObjectModelCreation> objectModelConsumer)

Description copied from interface: ObjectModelCreation

A function that creates a ObjectModelCreation and put is in the current ObjectModelCreation under the provided key when it isn't already set. The created ObjectModelCreation can be used to provide data for a nested Object. The consumption will only happen if the key is not already set.

Specified by:

putIfAbsent in interface ObjectModelCreation

Parameters:

key - key to store the object model under.

objectModelConsumer - a Consumer to fills the provided ObjectModelCreation with data.

putNull

public void putNull(String key)

Specified by:

putNull in interface ObjectModelCreation

putNullIfAbsent

public void putNullIfAbsent(String key)

Specified by:

putNullIfAbsent in interface ObjectModelCreation

createArray

public ArrayModelCreation createArray(String key)

Description copied from interface: ObjectModelCreation

A function that creates a ArrayModelCreation and put is in the current ObjectModelCreation under the provided key.

Specified by:

createArray in interface ObjectModelCreation

Parameters:

key - key to store the array model under.

Returns:

the array model.

createObject

public ObjectModelCreation createObject(String key)

Description copied from interface: ObjectModelCreation

A function that creates a ObjectModelCreation and put is in the current ObjectModelCreation under the provided key.

Specified by:

createObject in interface ObjectModelCreation

Parameters:

key - key to store the object model under.

Returns:

the array model.

has

public boolean has(String key)

Specified by:

has in interface ObjectModelRetrieval

hasNonNull

public boolean hasNonNull(String key)

Specified by:

hasNonNull in interface ObjectModelRetrieval

getString

public String getString(String property)

Specified by:

getString in interface ObjectModelRetrieval

getInteger

public int getInteger(String property)

Specified by:

getInteger in interface ObjectModelRetrieval

getBoolean

public boolean getBoolean(String property)

Specified by:

getBoolean in interface ObjectModelRetrieval

getStringArray

public String[] getStringArray(String property)

Specified by:

getStringArray in interface ObjectModelRetrieval

getStringList

public List<String> getStringList(String property)

Specified by:

getStringList in interface ObjectModelRetrieval

getStringStream

public Stream<String> getStringStream(String property)

Specified by:

getStringStream in interface ObjectModelRetrieval

getObject

public ObjectModelRetrieval getObject(String property)

Specified by:

getObject in interface ObjectModelRetrieval

getObjectStream

public Stream<ObjectModelRetrieval> getObjectStream(String property)

Specified by:

getObjectStream in interface ObjectModelRetrieval

isArray

public boolean isArray(String property)

Specified by:

isArray in interface ObjectModelRetrieval

toBytes

public byte[] toBytes()

Description copied from interface: ObjectModelStorage

A function that can be used to serialize the ObjectModelStorage to a byte array. The byte array represents a encoded UTF-8 JSON string of the object model.

Specified by:

toBytes in interface ObjectModelStorage

Returns:

a byte array containing the UTF-8 encode JSON string of the object model.

getProperties

public Stream<String> getProperties()

Specified by:

getProperties in interface ObjectModelRetrieval

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface ObjectModelRetrieval