CkJsonObject Java Reference Documentation

CkJsonObject

Current Version: 9.5.0.73

Represents a JSON object, which contains an unordered set of name/value pairs. Each value can be a string, number, JSON object, JSON array, true, false, or null.

Object Creation

CkJsonObject obj = new CkJsonObject();

Properties

DebugLogFilePath
void get_DebugLogFilePath(CkString str);
String debugLogFilePath();
void put_DebugLogFilePath(String newVal);

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
DelimiterChar
void get_DelimiterChar(CkString str);
String delimiterChar();
void put_DelimiterChar(String newVal);
Introduced in version 9.5.0.58

Sets the delimiter char for JSON paths. The default value is ".". To use Firebase style paths, set this property to "/". (This is a string property that should have a length of 1 char.)

top
EmitCompact
boolean get_EmitCompact();
void put_EmitCompact(boolean newVal);
Introduced in version 9.5.0.56

If true then the Emit method outputs in the most compact form possible (a single-line with no extra whitespace). If false, then emits with whitespace and indentation to make the JSON human-readable.

The default value is true.

top
EmitCrLf
boolean get_EmitCrLf();
void put_EmitCrLf(boolean newVal);
Introduced in version 9.5.0.56

If true then the Emit method uses CRLF line-endings when emitting the non-compact (pretty-print) format. If false, then bare-LF's are emitted. (The compact format emits to a single line with no end-of-line characters.) Windows systems traditionally use CRLF line-endings, whereas Linux, Mac OS X, and other systems traditionally use bare-LF line-endings.

The default value is true.

top
I
int get_I();
void put_I(int newVal);
Introduced in version 9.5.0.56

The value of the "i" index to be used when evaluating a JSON path.

More Information and Examples
top
J
int get_J();
void put_J(int newVal);
Introduced in version 9.5.0.56

The value of the "j" index to be used when evaluating a JSON path.

top
K
int get_K();
void put_K(int newVal);
Introduced in version 9.5.0.56

The value of the "k" index to be used when evaluating a JSON path.

top
LastErrorHtml
void get_LastErrorHtml(CkString str);
String lastErrorHtml();

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
void get_LastErrorText(CkString str);
String lastErrorText();

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
void get_LastErrorXml(CkString str);
String lastErrorXml();

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
boolean get_LastMethodSuccess();
void put_LastMethodSuccess(boolean newVal);
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = true and failure = false.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
Size
int get_Size();
Introduced in version 9.5.0.56

The number of name/value members in this JSON object.

top
VerboseLogging
boolean get_VerboseLogging();
void put_VerboseLogging(boolean newVal);

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
void get_Version(CkString str);
String version();

Version of the component/library, such as "9.5.0.63"

top

Methods

AddArrayAt
boolean AddArrayAt(int index, String name);
Introduced in version 9.5.0.56

Inserts a new and empty JSON array member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

top
AddBoolAt
boolean AddBoolAt(int index, String name, boolean value);
Introduced in version 9.5.0.56

Inserts a new boolean member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

top
AddIntAt
boolean AddIntAt(int index, String name, int value);
Introduced in version 9.5.0.56

Inserts a new integer member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

top
AddNullAt
boolean AddNullAt(int index, String name);
Introduced in version 9.5.0.56

Inserts a new null member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

top
AddNumberAt
boolean AddNumberAt(int index, String name, String numericStr);
Introduced in version 9.5.0.56

Inserts a new numeric member to the position indicated by index. The numericStr is an integer, float, or double already converted to a string in the format desired by the application. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

top
AddObjectAt
boolean AddObjectAt(int index, String name);
Introduced in version 9.5.0.56

Inserts a new and empty JSON object member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

top
AddStringAt
boolean AddStringAt(int index, String name, String value);
Introduced in version 9.5.0.56

Inserts a new string member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

top
AppendArray
CkJsonArray AppendArray(String name);
Introduced in version 9.5.0.58

Appends a new and empty JSON array and returns it.

Returns nil on failure

top
AppendBool
boolean AppendBool(String name, boolean value);
Introduced in version 9.5.0.58

Appends a new boolean member. (This is the same as passing -1 to the AddBoolAt method.)

Returns true for success, false for failure.

top
AppendInt
boolean AppendInt(String name, int value);
Introduced in version 9.5.0.58

Appends a new integer member. (This is the same as passing an index of -1 to the AddIntAt method.)

Returns true for success, false for failure.

top
AppendObject
CkJsonObject AppendObject(String name);
Introduced in version 9.5.0.58

Appends a new and empty JSON object and returns it.

Returns nil on failure

top
AppendString
boolean AppendString(String name, String value);
Introduced in version 9.5.0.58

Appends a new string member. (This is the same as passing -1 to the AddStringAt method.)

Returns true for success, false for failure.

top
AppendStringArray
boolean AppendStringArray(String name, CkStringTable values);
Introduced in version 9.5.0.67

Appends an array of string values.

Returns true for success, false for failure.

top
ArrayAt
CkJsonArray ArrayAt(int index);
Introduced in version 9.5.0.56

Returns the JSON array that is the value of the Nth member. Indexing is 0-based (the 1st member is at index 0).

Returns nil on failure

top
ArrayOf
CkJsonArray ArrayOf(String jsonPath);
Introduced in version 9.5.0.56

Returns the JSON array at the specified jsonPath.

Returns nil on failure

top
BoolAt
boolean BoolAt(int index);
Introduced in version 9.5.0.56

Returns the boolean value of the Nth member. Indexing is 0-based (the 1st member is at index 0).

top
BoolOf
boolean BoolOf(String jsonPath);
Introduced in version 9.5.0.56

Returns the boolean at the specified jsonPath.

top
BytesOf
boolean BytesOf(String jsonPath, String encoding, CkBinData bd);
Introduced in version 9.5.0.68

Appends the binary bytes at the specified jsonPath to bd. The encoding indicates the encoding of the bytes, such as "base64", "hex", etc.

Returns true for success, false for failure.

top
Clone
CkJsonObject Clone();
Introduced in version 9.5.0.66

Returns a copy of this JSON object.

Returns nil on failure

top
DateOf
boolean DateOf(String jsonPath, CkDateTime dateTime);
Introduced in version 9.5.0.73

Fills the dateTime with the date/time string located at jsonPath. Auto-recognizes the following date/time string formats: ISO-8061 Timestamp (such as "2009-11-04T19:55:41Z"), RFC822 date/time format (such as "Wed, 18 Apr 2018 15:51:55 -0400"), or Unix timestamp integers.

Returns true for success, false for failure.

top
Delete
boolean Delete(String name);
Introduced in version 9.5.0.56

Deletes the member at having the name specified by name.

Returns true for success, false for failure.

top
DeleteAt
boolean DeleteAt(int index);
Introduced in version 9.5.0.56

Deletes the member at index index. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

top
DtOf
boolean DtOf(String jsonPath, boolean bLocal, CkDtObj dt);
Introduced in version 9.5.0.73

Fills the dt with the date/time string located at jsonPath. If bLocal is true, then dt is filled with the local date/time values, otherwise it is filled with the UTC/GMT values. Auto-recognizes the following date/time string formats: ISO-8061 Timestamp (such as "2009-11-04T19:55:41Z"), RFC822 date/time format (such as "Wed, 18 Apr 2018 15:51:55 -0400"), or Unix timestamp integers.

Returns true for success, false for failure.

top
Emit
boolean Emit(CkString outStr);
String emit();
Introduced in version 9.5.0.56

Writes the JSON document (rooted at the caller) and returns as a string.

Returns true for success, false for failure.

top
EmitSb
boolean EmitSb(CkStringBuilder sb);
Introduced in version 9.5.0.62

Appends the JSON to a StringBuilder object.

Returns true for success, false for failure.

top
EmitWithSubs
boolean EmitWithSubs(CkHashtable subs, boolean omitEmpty, CkString outStr);
String emitWithSubs(CkHashtable subs, boolean omitEmpty);
Introduced in version 9.5.0.67

Emits the JSON document with variable substitutions applied. If omitEmpty is true, then members having empty strings or empty arrays are omitted.

Returns true for success, false for failure.

top
FindObjectWithMember
CkJsonObject FindObjectWithMember(String name);
Introduced in version 9.5.0.67

Recursively searches the JSON subtree rooted at the caller's node for a JSON object containing a member having a specified name. (If the caller is the root node of the entire JSON document, then the entire JSON document is searched.) Returns the first match or nil if not found.

Returns nil on failure

top
FindRecord
CkJsonObject FindRecord(String arrayPath, String relPath, String value, boolean caseSensitive);
Introduced in version 9.5.0.63

Finds a JSON record in an array where a particular field equals or matches a value pattern. Reviewing the example below is the best way to understand this function.

Returns nil on failure

top
FindRecordString
boolean FindRecordString(String arrayPath, String relPath, String value, boolean caseSensitive, String retRelPath, CkString outStr);
String findRecordString(String arrayPath, String relPath, String value, boolean caseSensitive, String retRelPath);
Introduced in version 9.5.0.63

Finds a JSON value in an record array where a particular field equals or matches a value pattern. Reviewing the example below is the best way to understand this function.

Returns true for success, false for failure.

top
FirebaseApplyEvent
boolean FirebaseApplyEvent(String name, String data);
Introduced in version 9.5.0.58

Applies a Firebase event to the JSON. The data contains JSON having a format such as

{"path": "/", "data": {"a": 1, "b": 2}}
The name should be "put" or "patch".

Returns true for success, false for failure.

top
FirebasePatch
boolean FirebasePatch(String jsonPath, String jsonData);
Introduced in version 9.5.0.58

For each key in the jsonData, update (or add) the corresponding key in the JSON at the given jsonPath. The jsonPath is relative to this JSON object. (This is effectively applying a Firebase patch event.)

Returns true for success, false for failure.

top
FirebasePut
boolean FirebasePut(String jsonPath, String value);
Introduced in version 9.5.0.58

Inserts or replaces the value at the jsonPath. The value can contain JSON text, an integer (in decimal string format), a boolean (true/false), the keyword "null", or a quoted string.

The jsonPath is relative to this JSON object. (This is effectively applying a Firebase put event.)

Returns true for success, false for failure.

top
GetDocRoot
CkJsonObject GetDocRoot();
Introduced in version 9.5.0.56

Returns the root of the JSON document. The root can be obtained from any JSON object within the JSON document. The entire JSON document remains in memory as long as at least one JSON object is referenced by the application. When the last reference is removed, the entire JSON document is automatically dellocated.

Returns nil on failure

top
HasMember
boolean HasMember(String jsonPath);
Introduced in version 9.5.0.58

Returns true if the item at the jsonPath exists.

Returns true for success, false for failure.

top
IndexOf
int IndexOf(String name);
Introduced in version 9.5.0.56

Returns the index of the member having the given name. Returns -1 if the name is not found.

top
IntAt
int IntAt(int index);
Introduced in version 9.5.0.56

Returns the integer value of the Nth member. Indexing is 0-based (the 1st member is at index 0).

top
IntOf
int IntOf(String jsonPath);
Introduced in version 9.5.0.56

Returns the integer at the specified jsonPath.

top
IsNullAt
boolean IsNullAt(int index);
Introduced in version 9.5.0.56

Returns the boolean value of the member having the specified index.

top
IsNullOf
boolean IsNullOf(String jsonPath);
Introduced in version 9.5.0.56

Returns true if the value at the specified jsonPath is null. Otherwise returns false.

top
Load
boolean Load(String json);
Introduced in version 9.5.0.56

Parses a JSON string and loads it into this JSON object to provide DOM-style access.

Returns true for success, false for failure.

top
LoadFile
boolean LoadFile(String path);
Introduced in version 9.5.0.56

Loads a JSON file into this JSON object. The path is the file path to the JSON file.

Returns true for success, false for failure.

top
LoadPredefined
boolean LoadPredefined(String name);
Introduced in version 9.5.0.67

Loads this JSON object from a predefined document having a specified name.

Returns true for success, false for failure.

top
LoadSb
boolean LoadSb(CkStringBuilder sb);
Introduced in version 9.5.0.62

Loads JSON from the contents of a StringBuilder object.

Returns true for success, false for failure.

top
NameAt
boolean NameAt(int index, CkString outStr);
String nameAt(int index);
Introduced in version 9.5.0.56

Returns the name of the Nth member. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

top
ObjectAt
CkJsonObject ObjectAt(int index);
Introduced in version 9.5.0.56

Returns the JSON object that is the value of the Nth member. Indexing is 0-based (the 1st member is at index 0).

Returns nil on failure

top
ObjectOf
CkJsonObject ObjectOf(String jsonPath);
Introduced in version 9.5.0.56

Returns the JSON object at the specified jsonPath.

Returns nil on failure

top
Predefine
boolean Predefine(String name);
Introduced in version 9.5.0.67

Adds or replaces this JSON to an internal global set of predefined JSON documents that can be subsequently loaded by name.

Returns true for success, false for failure.

top
Rename
boolean Rename(String oldName, String newName);
Introduced in version 9.5.0.56

Renames the member named oldName to newName.

Returns true for success, false for failure.

top
RenameAt
boolean RenameAt(int index, String name);
Introduced in version 9.5.0.56

Renames the member at index to name.

Returns true for success, false for failure.

top
SaveLastError
boolean SaveLastError(String path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns true for success, false for failure.

top
SetBoolAt
boolean SetBoolAt(int index, boolean value);
Introduced in version 9.5.0.56

Sets the boolean value of the Nth member. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

top
SetBoolOf
boolean SetBoolOf(String jsonPath, boolean value);
Introduced in version 9.5.0.56

Sets the boolean value at the specified jsonPath.

Returns true for success, false for failure.

top
SetIntAt
boolean SetIntAt(int index, int value);
Introduced in version 9.5.0.56

Sets the integer value of the Nth member. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

top
SetIntOf
boolean SetIntOf(String jsonPath, int value);
Introduced in version 9.5.0.56

Sets the integer at the specified jsonPath.

Returns true for success, false for failure.

top
SetNullAt
boolean SetNullAt(int index);
Introduced in version 9.5.0.56

Sets the value of the Nth member to null. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

top
SetNullOf
boolean SetNullOf(String jsonPath);
Introduced in version 9.5.0.56

Sets the value at the specified jsonPath to null.

Returns true for success, false for failure.

top
SetNumberAt
boolean SetNumberAt(int index, String value);
Introduced in version 9.5.0.56

Sets the numeric value of the Nth member. The value is an integer, float, or double already converted to a string in the format desired by the application. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

top
SetNumberOf
boolean SetNumberOf(String jsonPath, String value);
Introduced in version 9.5.0.56

Sets the numeric value at the specified jsonPath. The value is an integer, float, or double already converted to a string in the format desired by the application.

Returns true for success, false for failure.

top
SetStringAt
boolean SetStringAt(int index, String value);
Introduced in version 9.5.0.56

Sets the string value of the Nth member. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

top
SetStringOf
boolean SetStringOf(String jsonPath, String value);
Introduced in version 9.5.0.56

Sets the string value at the specified jsonPath.

Returns true for success, false for failure.

top
SizeOfArray
int SizeOfArray(String jsonPath);
Introduced in version 9.5.0.56

Returns the size of the array at the given jsonPath. Returns -1 if the jsonPath does not evaluate to an existent JSON array.

More Information and Examples
top
StringAt
boolean StringAt(int index, CkString outStr);
String stringAt(int index);
Introduced in version 9.5.0.56

Returns the string value of the Nth member. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

top
StringOf
boolean StringOf(String jsonPath, CkString outStr);
String stringOf(String jsonPath);
Introduced in version 9.5.0.56

Returns the string value at the specified jsonPath.

Returns true for success, false for failure.

top
StringOfSb
boolean StringOfSb(String jsonPath, CkStringBuilder sb);
Introduced in version 9.5.0.68

Appends the string value at the specified jsonPath to sb.

Returns true for success, false for failure.

top
TypeAt
int TypeAt(int index);
Introduced in version 9.5.0.58

Returns the type of data at the given index. Possible return values are:

  1. string
  2. number
  3. object
  4. array
  5. boolean
  6. null
Returns -1 if no member exists at the given index.

top
UpdateBd
boolean UpdateBd(String jsonPath, String encoding, CkBinData bd);
Introduced in version 9.5.0.68

Updates or appends a new string member with the encoded contents of bd. If the full path specified by jsonPath does not exist, it is automatically created as needed. The bytes contained in bd are encoded according to encoding (such as "base64", "hex", etc.)

Returns true for success, false for failure.

top
UpdateBool
boolean UpdateBool(String jsonPath, boolean value);
Introduced in version 9.5.0.63

Updates or appends a new boolean member. If the full path specified by jsonPath does not exist, it is automatically created as needed.

Returns true for success, false for failure.

top
UpdateInt
boolean UpdateInt(String jsonPath, int value);
Introduced in version 9.5.0.63

Updates or appends a new integer member. If the full path specified by jsonPath does not exist, it is automatically created as needed.

Returns true for success, false for failure.

top
UpdateNewArray
boolean UpdateNewArray(String jsonPath);
Introduced in version 9.5.0.75

Updates or appends a new and empty array at the jsonPath. If the full path specified by jsonPath does not exist, it is automatically created as needed.

Returns true for success, false for failure.

top
UpdateNewObject
boolean UpdateNewObject(String jsonPath);
Introduced in version 9.5.0.75

Updates or appends a new and empty array at the jsonPath. If the full path specified by jsonPath does not exist, it is automatically created as needed.

Returns true for success, false for failure.

top
UpdateNull
boolean UpdateNull(String jsonPath);
Introduced in version 9.5.0.65

Updates or appends a null member. If the full path specified by jsonPath does not exist, it is automatically created as needed.

Returns true for success, false for failure.

top
UpdateNumber
boolean UpdateNumber(String jsonPath, String numericStr);
Introduced in version 9.5.0.65

Updates or appends a new numeric member. If the full path specified by jsonPath does not exist, it is automatically created as needed.

Returns true for success, false for failure.

top
UpdateSb
boolean UpdateSb(String jsonPath, CkStringBuilder sb);
Introduced in version 9.5.0.68

Updates or appends a new string member with the contents of sb. If the full path specified by jsonPath does not exist, it is automatically created as needed.

Returns true for success, false for failure.

top
UpdateString
boolean UpdateString(String jsonPath, String value);
Introduced in version 9.5.0.63

Updates or appends a new string member. If the full path specified by jsonPath does not exist, it is automatically created as needed.

Important: Prior to version 9.5.0.68, the string passed in to this method did not get properly JSON escaped. This could cause problems if non-us-ascii chars are present, or if certain special chars such as quotes, CR's, or LF's are present. Version 9.5.0.68 fixes the problem.

Returns true for success, false for failure.

top