Package com.flowable.platform.engine.impl.scripting

Class ScriptingJsonObject

java.lang.Object

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

All Implemented Interfaces:

Iterable<ScriptingJsonObject>, Supplier<com.fasterxml.jackson.databind.JsonNode>

public class ScriptingJsonObject
extends Object
implements Supplier<com.fasterxml.jackson.databind.JsonNode>, Iterable<ScriptingJsonObject>

Field Summary

Fields

Modifier and Type	Field	Description
protected com.fasterxml.jackson.databind.JsonNode	jsonNode

Constructor Summary

Constructors

Constructor	Description
ScriptingJsonObject(com.fasterxml.jackson.databind.JsonNode 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 com.fasterxml.jackson.databind.node.ArrayNode	checkIsArrayNode(String action)
protected com.fasterxml.jackson.databind.node.ObjectNode	checkIsObjectNode(String action)
ScriptingJsonObject	createChildArray(String fieldName)
ScriptingJsonObject	createChildObject(String fieldName)
com.fasterxml.jackson.databind.JsonNode	get()
com.fasterxml.jackson.databind.JsonNode	getJsonNode()
boolean	isArray()
boolean	isBoolean()
boolean	isNonNull()
boolean	isNumber()
boolean	isObject()
boolean	isPresent()
boolean	isString()
boolean	isValue()
Iterator<ScriptingJsonObject>	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 java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

jsonNode

protected com.fasterxml.jackson.databind.JsonNode jsonNode

Constructor Detail

ScriptingJsonObject

public ScriptingJsonObject(com.fasterxml.jackson.databind.JsonNode jsonNode)

Method Detail

createChildObject

public ScriptingJsonObject createChildObject(String fieldName)

createChildArray

public ScriptingJsonObject createChildArray(String fieldName)

putString

public ScriptingJsonObject putString(String fieldName,
                                     String value)

putInteger

public ScriptingJsonObject putInteger(String fieldName,
                                      Number value)

putInt

public ScriptingJsonObject putInt(String fieldName,
                                  int value)

putBoolean

public ScriptingJsonObject putBoolean(String fieldName,
                                      Boolean value)

putShort

public ScriptingJsonObject putShort(String fieldName,
                                    Number value)

putShort

public ScriptingJsonObject putShort(String fieldName,
                                    short value)

putLong

public ScriptingJsonObject putLong(String fieldName,
                                   Number value)

putLong

public ScriptingJsonObject putLong(String fieldName,
                                   long value)

putDouble

public ScriptingJsonObject putDouble(String fieldName,
                                     Number value)

putDouble

public ScriptingJsonObject putDouble(String fieldName,
                                     double value)

putFloat

public ScriptingJsonObject putFloat(String fieldName,
                                    Number value)

putFloat

public ScriptingJsonObject putFloat(String fieldName,
                                    float value)

putObject

public ScriptingJsonObject putObject(String fieldName,
                                     Object value)

putNull

public ScriptingJsonObject putNull(String fieldName)

addString

public ScriptingJsonObject addString(String value)

addInteger

public ScriptingJsonObject addInteger(Number value)

addInt

public ScriptingJsonObject addInt(int value)

addBoolean

public ScriptingJsonObject addBoolean(Boolean value)

addShort

public ScriptingJsonObject addShort(Number value)

addShort

public ScriptingJsonObject addShort(short value)

addLong

public ScriptingJsonObject addLong(Number value)

addLong

public ScriptingJsonObject addLong(long value)

addDouble

public ScriptingJsonObject addDouble(Number value)

addDouble

public ScriptingJsonObject addDouble(double value)

addFloat

public ScriptingJsonObject addFloat(Number value)

addFloat

public ScriptingJsonObject addFloat(float value)

addObject

public ScriptingJsonObject addObject(Object value)

addNull

public ScriptingJsonObject addNull()

path

public ScriptingJsonObject path(String path)

path

public ScriptingJsonObject path(int index)

size

public int size()

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()

Returns:

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

Throws:

FlowableException - when this node is empty or null, not a number or exceeds integer range.

asLong

public Long asLong()

Returns:

this number value as long.

Throws:

FlowableException - when this node is empty or null or not a number.

asBoolean

public Boolean asBoolean()

Returns:

this value as boolean.

Throws:

FlowableException - when this node is empty or null or not a boolean.

asDouble

public Double asDouble()

Returns:

this number value as double.

Throws:

FlowableException - when this node is empty or null or not a number.

asString

public String asString()

Returns:

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

Throws:

FlowableException - when this node is not a value node.

iterator

public Iterator<ScriptingJsonObject> iterator()

Specified by:

iterator in interface Iterable<ScriptingJsonObject>

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.

isValue

public boolean isValue()

Returns:

true if this json node is a value node.

isArray

public boolean isArray()

Returns:

true if this json node is an array node.

isObject

public boolean isObject()

Returns:

true if this json node is an object node.

isString

public boolean isString()

Returns:

true if this json node is a string

isNumber

public boolean isNumber()

Returns:

true if this json node is a number

isBoolean

public boolean isBoolean()

Returns:

true if this json node is a boolean

isNonNull

public boolean isNonNull()

isPresent

public boolean isPresent()

checkForNull

protected void checkForNull(String action)

checkIsObjectNode

protected com.fasterxml.jackson.databind.node.ObjectNode checkIsObjectNode(String action)

checkIsArrayNode

protected com.fasterxml.jackson.databind.node.ArrayNode checkIsArrayNode(String action)

get

public com.fasterxml.jackson.databind.JsonNode get()

Specified by:

get in interface Supplier<com.fasterxml.jackson.databind.JsonNode>

getJsonNode

public com.fasterxml.jackson.databind.JsonNode 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(ScriptingJsonObject)

Overrides:

toString in class Object

Returns:

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