JSONParser

Method Summary
String[]	getChildren(String path) Returns all of the node names for the specified path.
String	getNodeType(String path) Returns the object type of the jsonpath expression target. Result will be string, number, boolean, object, array, list, unknown, 'null', or null
boolean	hasPath(String path) Returns true if the jsonpath expression results in a non null endpoint.
DataList	readChildren(String path) Reads the child nodes of the given path and returns a DataList containing child names and types
Data	readData(String path) Creates a Data object by evaluating the jsonpath expression. If the target is an array or a non-text collection, an empty Data is returned. Child objects and arrays are omitted.
Data	readData(String path, boolean prefixEnabled) Creates a Data object by evaluating the jsonpath expression. If the target is an array or collection, an empty Data is returned. If the target contains a child object or array, the child object or array is serialized as a JSON string.
DataList	readDataList(String name, String path) Creates a DataList object by evaluating the jsonpath expression. Returns null if path not found. Child objects and arrays are ignored.
DataList	readDataList(String name, String path, boolean prefixEnabled) Creates a DataList object by evaluating the jsonpath expression. Returns null if path not found. Child objects and arrays are serialized to a JSON string.
JSONParser	readPath(String path) Creates a JSONParser object by evaluating the jsonpath expression. Returns null if path not found or the value of the path is null or the endpoint is not an object.
Payload	readPayload(String path) Creates a Payload object by evaluating the jsonpath expression. Returns null if path not found.
Payload	readPayload(String path, boolean prefixEnabled) Creates a Payload object by evaluating the jsonpath expression. Returns null if path not found. Child objects and arrays are serialized to JSON string
String	readValue(String path) Returns the value by evaluating the jsonpath expression.
	reload(String json) Reloads this object with the specified json string.
String	toJson() Returns the content of this JSONParser as JSON.
String	toString() Returns a description of this object.

Method Detail

String[] getChildren(String path)

Returns all of the node names for the specified path.

Parameters:

String path Required parameter.

Returns: String[]

Since: 01-29-2016

top

String getNodeType(String path)

Returns the object type of the jsonpath expression target. Result will be string, number, boolean, object, array, list, unknown, 'null', or null

Parameters:

String path Required parameter.

Returns: String

Since: 01-29-2016

top

boolean hasPath(String path)

Returns true if the jsonpath expression results in a non null endpoint.

Parameters:

String path Required parameter.

Returns: boolean

Since: 01-29-2016

top

DataList readChildren(String path)

Reads the child nodes of the given path and returns a DataList containing child names and types

Parameters:

String path Required parameter.

Returns: DataList

DataList Name: nodes
DataList Fields: name, type, length

Since: 01-29-2016

top

Data readData(String path)

Creates a Data object by evaluating the jsonpath expression. If the target is an array or a non-text collection, an empty Data is returned. Child objects and arrays are omitted.

Parameters:

String path Required parameter.

Returns: Data

Since: 01-29-2016

top

Data readData(String path, boolean prefixEnabled)

Creates a Data object by evaluating the jsonpath expression. If the target is an array or collection, an empty Data is returned. If the target contains a child object or array, the child object or array is serialized as a JSON string.

Parameters:

String path Required parameter.
boolean prefixEnabled - If true, serialized JSON objects are serialized with their parent name as a root object..

Returns: Data

Since: 01-29-2016

top

DataList readDataList(String name, String path)

Creates a DataList object by evaluating the jsonpath expression. Returns null if path not found. Child objects and arrays are ignored.

Parameters:

String name - name of the resulting list. Required parameter.
String path Required parameter.

Returns: DataList

Since: 01-29-2016

top

DataList readDataList(String name, String path, boolean prefixEnabled)

Creates a DataList object by evaluating the jsonpath expression. Returns null if path not found. Child objects and arrays are serialized to a JSON string.

Parameters:

String name - name of the resulting list. Required parameter.
String path Required parameter.
boolean prefixEnabled - If true, serialized JSON objects are serialized with their parent name as a root object..

Returns: DataList

Since: 01-29-2016

top

JSONParser readPath(String path)

Creates a JSONParser object by evaluating the jsonpath expression. Returns null if path not found or the value of the path is null or the endpoint is not an object.

Parameters:

String path Required parameter.

Returns: JSONParser

Since: 01-29-2016

top

Payload readPayload(String path)

Creates a Payload object by evaluating the jsonpath expression. Returns null if path not found.

Parameters:

String path Required parameter.

Returns: Payload

Since: 01-29-2016

top

Payload readPayload(String path, boolean prefixEnabled)

Creates a Payload object by evaluating the jsonpath expression. Returns null if path not found. Child objects and arrays are serialized to JSON string

Parameters:

String path Required parameter.
boolean prefixEnabled - If true, serialized JSON objects are serialized with their parent name as a root object..

Returns: Payload

Since: 01-29-2016

top

String readValue(String path)

Returns the value by evaluating the jsonpath expression.

Parameters:

String path Required parameter.

Returns: String

Since: 01-29-2016

top

reload(String json)

Reloads this object with the specified json string.

Parameters:

String json Required parameter.

Since: 01-29-2016

top

String toJson()

Returns the content of this JSONParser as JSON.

Returns: String

Since: 11-08-2016

top

String toString()

Returns a description of this object.

Returns: String

Since: 01-29-2016

top

API Date: Dec 03, 2024 10:24 AM