Class ScriptingJsonObject

java.lang.Object

com.flowable.platform.engine.impl.scripting.ScriptingJsonObject

All Implemented Interfaces:

ScriptingJsonNode, Iterable<ScriptingJsonNode>, Supplier<Object>

public class ScriptingJsonObject
extends Object
implements Supplier<Object>, ScriptingJsonNode

Field Summary

Fields

Modifier and Type	Field	Description
protected org.flowable.common.engine.impl.json.FlowableJsonNode	jsonNode

Constructor Summary

Constructors

Constructor	Description
ScriptingJsonObject(org.flowable.common.engine.impl.json.FlowableJsonNode jsonNode)

Method Summary

Modifier and Type	Method	Description
ScriptingJsonObject	addBoolean(Boolean value)
ScriptingJsonObject	addDouble(double value)
ScriptingJsonObject	addDouble(Number value)
ScriptingJsonObject	addFloat(float value)
ScriptingJsonObject	addFloat(Number value)
ScriptingJsonObject	addInt(int value)
ScriptingJsonObject	addInteger(Number value)
ScriptingJsonObject	addLong(long value)
ScriptingJsonObject	addLong(Number value)
ScriptingJsonObject	addNull()
ScriptingJsonObject	addObject(Object value)
ScriptingJsonObject	addShort(short value)
ScriptingJsonObject	addShort(Number value)
ScriptingJsonObject	addString(String value)
Boolean	asBoolean()
Double	asDouble()
Integer	asInteger()
Long	asLong()
String	asString()
protected void	checkForNull(String action)
protected org.flowable.common.engine.impl.json.FlowableArrayNode	checkIsArrayNode(String action)
protected org.flowable.common.engine.impl.json.FlowableObjectNode	checkIsObjectNode(String action)
ScriptingJsonObject	createChildArray(String fieldName)
ScriptingJsonObject	createChildObject(String fieldName)
Collection<String>	fieldNames()
Object	get()
Object	getJsonNode()
boolean	isArray()
boolean	isBoolean()
boolean	isNonNull()
boolean	isNumber()
boolean	isObject()
boolean	isPresent()
boolean	isString()
boolean	isValue()
Iterator<ScriptingJsonNode>	iterator()
ScriptingJsonObject	path(int index)
ScriptingJsonObject	path(String path)
ScriptingJsonObject	putBoolean(String fieldName, Boolean value)
ScriptingJsonObject	putDouble(String fieldName, double value)
ScriptingJsonObject	putDouble(String fieldName, Number value)
ScriptingJsonObject	putFloat(String fieldName, float value)
ScriptingJsonObject	putFloat(String fieldName, Number value)
ScriptingJsonObject	putInt(String fieldName, int value)
ScriptingJsonObject	putInteger(String fieldName, Number value)
ScriptingJsonObject	putLong(String fieldName, long value)
ScriptingJsonObject	putLong(String fieldName, Number value)
ScriptingJsonObject	putNull(String fieldName)
ScriptingJsonObject	putObject(String fieldName, Object value)
ScriptingJsonObject	putShort(String fieldName, short value)
ScriptingJsonObject	putShort(String fieldName, Number value)
ScriptingJsonObject	putString(String fieldName, String value)
int	size()
String	toString()	Returns a toString representation of this ScriptingJsonObject.

Methods inherited from class Object

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

Methods inherited from interface Iterable

forEach, spliterator

Field Details

jsonNode

protected org.flowable.common.engine.impl.json.FlowableJsonNode jsonNode

Constructor Details

ScriptingJsonObject

public ScriptingJsonObject(org.flowable.common.engine.impl.json.FlowableJsonNode jsonNode)

Method Details

createChildObject

public ScriptingJsonObject createChildObject(String fieldName)

Specified by:

createChildObject in interface ScriptingJsonNode

createChildArray

public ScriptingJsonObject createChildArray(String fieldName)

Specified by:

createChildArray in interface ScriptingJsonNode

putString

public ScriptingJsonObject putString(String fieldName,
 String value)

Specified by:

putString in interface ScriptingJsonNode

putInteger

public ScriptingJsonObject putInteger(String fieldName,
 Number value)

Specified by:

putInteger in interface ScriptingJsonNode

putInt

public ScriptingJsonObject putInt(String fieldName,
 int value)

Specified by:

putInt in interface ScriptingJsonNode

putBoolean

public ScriptingJsonObject putBoolean(String fieldName,
 Boolean value)

Specified by:

putBoolean in interface ScriptingJsonNode

putShort

public ScriptingJsonObject putShort(String fieldName,
 Number value)

Specified by:

putShort in interface ScriptingJsonNode

putShort

public ScriptingJsonObject putShort(String fieldName,
 short value)

Specified by:

putShort in interface ScriptingJsonNode

putLong

public ScriptingJsonObject putLong(String fieldName,
 Number value)

Specified by:

putLong in interface ScriptingJsonNode

putLong

public ScriptingJsonObject putLong(String fieldName,
 long value)

Specified by:

putLong in interface ScriptingJsonNode

putDouble

public ScriptingJsonObject putDouble(String fieldName,
 Number value)

Specified by:

putDouble in interface ScriptingJsonNode

putDouble

public ScriptingJsonObject putDouble(String fieldName,
 double value)

Specified by:

putDouble in interface ScriptingJsonNode

putFloat

public ScriptingJsonObject putFloat(String fieldName,
 Number value)

Specified by:

putFloat in interface ScriptingJsonNode

putFloat

public ScriptingJsonObject putFloat(String fieldName,
 float value)

Specified by:

putFloat in interface ScriptingJsonNode

putObject

public ScriptingJsonObject putObject(String fieldName,
 Object value)

Specified by:

putObject in interface ScriptingJsonNode

putNull

public ScriptingJsonObject putNull(String fieldName)

Specified by:

putNull in interface ScriptingJsonNode

addString

public ScriptingJsonObject addString(String value)

Specified by:

addString in interface ScriptingJsonNode

addInteger

public ScriptingJsonObject addInteger(Number value)

Specified by:

addInteger in interface ScriptingJsonNode

addInt

public ScriptingJsonObject addInt(int value)

Specified by:

addInt in interface ScriptingJsonNode

addBoolean

public ScriptingJsonObject addBoolean(Boolean value)

Specified by:

addBoolean in interface ScriptingJsonNode

addShort

public ScriptingJsonObject addShort(Number value)

Specified by:

addShort in interface ScriptingJsonNode

addShort

public ScriptingJsonObject addShort(short value)

Specified by:

addShort in interface ScriptingJsonNode

addLong

public ScriptingJsonObject addLong(Number value)

Specified by:

addLong in interface ScriptingJsonNode

addLong

public ScriptingJsonObject addLong(long value)

Specified by:

addLong in interface ScriptingJsonNode

addDouble

public ScriptingJsonObject addDouble(Number value)

Specified by:

addDouble in interface ScriptingJsonNode

addDouble

public ScriptingJsonObject addDouble(double value)

Specified by:

addDouble in interface ScriptingJsonNode

addFloat

public ScriptingJsonObject addFloat(Number value)

Specified by:

addFloat in interface ScriptingJsonNode

addFloat

public ScriptingJsonObject addFloat(float value)

Specified by:

addFloat in interface ScriptingJsonNode

addObject

public ScriptingJsonObject addObject(Object value)

Specified by:

addObject in interface ScriptingJsonNode

addNull

public ScriptingJsonObject addNull()

Specified by:

addNull in interface ScriptingJsonNode

path

public ScriptingJsonObject path(String path)

Specified by:

path in interface ScriptingJsonNode

path

public ScriptingJsonObject path(int index)

Specified by:

path in interface ScriptingJsonNode

size

public int size()

Specified by:

size in interface ScriptingJsonNode

Returns:

the number of elements for this json node (array length for array nodes or number of attributes for object nodes).

asInteger

public Integer asInteger()

Specified by:

asInteger in interface ScriptingJsonNode

Returns:

this value as integer in case it is a numeric value.

Throws:

org.flowable.common.engine.api.FlowableException - when this node is empty or null, not a number or exceeds integer range.

asLong

public Long asLong()

Specified by:

asLong in interface ScriptingJsonNode

Returns:

this number value as long.

Throws:

org.flowable.common.engine.api.FlowableException - when this node is empty or null or not a number.

asBoolean

public Boolean asBoolean()

Specified by:

asBoolean in interface ScriptingJsonNode

Returns:

this value as boolean.

Throws:

org.flowable.common.engine.api.FlowableException - when this node is empty or null or not a boolean.

asDouble

public Double asDouble()

Specified by:

asDouble in interface ScriptingJsonNode

Returns:

this number value as double.

Throws:

org.flowable.common.engine.api.FlowableException - when this node is empty or null or not a number.

asString

public String asString()

Specified by:

asString in interface ScriptingJsonNode

Returns:

a string representation of this node, if this node is a value node (isValue() returns true).

Throws:

org.flowable.common.engine.api.FlowableException - when this node is not a value node.

iterator

public Iterator<ScriptingJsonNode> iterator()

Specified by:

iterator in interface Iterable<ScriptingJsonNode>

Returns:

an iterator of this node. Wraps each object into a ScriptingJsonObject when this node is an array node. Otherwise, a single item iterator is returned.

fieldNames

public Collection<String> fieldNames()

Specified by:

fieldNames in interface ScriptingJsonNode

Returns:

collection of field names for object nodes. Empty collection for non-object nodes.

isValue

public boolean isValue()

Specified by:

isValue in interface ScriptingJsonNode

Returns:

true if this json node is a value node.

isArray

public boolean isArray()

Specified by:

isArray in interface ScriptingJsonNode

Returns:

true if this json node is an array node.

isObject

public boolean isObject()

Specified by:

isObject in interface ScriptingJsonNode

Returns:

true if this json node is an object node.

isString

public boolean isString()

Specified by:

isString in interface ScriptingJsonNode

Returns:

true if this json node is a string

isNumber

public boolean isNumber()

Specified by:

isNumber in interface ScriptingJsonNode

Returns:

true if this json node is a number

isBoolean

public boolean isBoolean()

Specified by:

isBoolean in interface ScriptingJsonNode

Returns:

true if this json node is a boolean

isNonNull

public boolean isNonNull()

Specified by:

isNonNull in interface ScriptingJsonNode

isPresent

public boolean isPresent()

Specified by:

isPresent in interface ScriptingJsonNode

checkForNull

protected void checkForNull(String action)

checkIsObjectNode

protected org.flowable.common.engine.impl.json.FlowableObjectNode checkIsObjectNode(String action)

checkIsArrayNode

protected org.flowable.common.engine.impl.json.FlowableArrayNode checkIsArrayNode(String action)

get

public Object get()

Specified by:

get in interface Supplier<Object>

getJsonNode

public Object getJsonNode()

toString

public String toString()

Returns a toString representation of this ScriptingJsonObject.

NOTE: Even though this method returns some json content, do not rely on it for parsing the content. Use a proper json generator to create a json string instead e.g. ScriptingJsonUtils.jsonToString(ScriptingJsonNode)

Overrides:

toString in class Object

Returns:

the string representation of this json for diagnostic purposes (not for processing).