CkJsonArray Java Reference Documentation

CkJsonArray

Current Version: 9.5.0.75

Represents a JSON array, which contains an ordered list of JSON values, where each value can be a string, number, JSON object, JSON array, true, false, or null.

Object Creation

CkJsonArray obj = new CkJsonArray();

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
EmitCompact
boolean get_EmitCompact();
void put_EmitCompact(boolean newVal);
Introduced in version 9.5.0.64

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.64

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
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 JSON values in the array.

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);
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, 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, 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);
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 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);
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 value);
Introduced in version 9.5.0.56

Inserts a new string at 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
ArrayAt
CkJsonArray ArrayAt(int index);
Introduced in version 9.5.0.56

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

Returns nil on failure

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

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

top
Clear
void Clear();
Introduced in version 9.5.0.76

Deletes all array elements.

top
DateAt
boolean DateAt(int index, CkDateTime dateTime);
Introduced in version 9.5.0.73

Fills the dateTime with the date/time string located in the Nth array element. Indexing is 0-based (the 1st member is at index 0). 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
DeleteAt
boolean DeleteAt(int index);
Introduced in version 9.5.0.56

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

Returns true for success, false for failure.

top
DtAt
boolean DtAt(int index, boolean bLocal, CkDtObj dt);
Introduced in version 9.5.0.73

Fills the dt with the date/time string located in the Nth array element. If bLocal is true, then dt is filled with the local date/time values, otherwise it is filled with the UTC/GMT values. Indexing is 0-based (the 1st member is at index 0). 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.58

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

Note: To control the compact/non-compact format, and to control the LF/CRLF line-endings, set the EmitCompact and EmitCrlf properties.

Returns true for success, false for failure.

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

Writes the JSON array to the sb.

Note: To control the compact/non-compact format, and to control the LF/CRLF line-endings, set the EmitCompact and EmitCrlf properties.

Returns true for success, false for failure.

top
FindObject
int FindObject(String name, String value, boolean caseSensitive);
Introduced in version 9.5.0.73

Return the index of the first object in the array where value of the field at name matches value. name is an object member name. The value is a value pattern which can use "*" chars to indicate zero or more of any char. If caseSensitive is false, then the matching is case insenstive, otherwise it is case sensitive. Returns -1 if no matching string was found.

top
FindString
int FindString(String value, boolean caseSensitive);
Introduced in version 9.5.0.73

Return the index of the first matching string in the array. The value is a value pattern which can use "*" chars to indicate zero or more of any char. If caseSensitive is false, then the matching is case insenstive, otherwise it is case sensitive. Returns -1 if no matching string was found.

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

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

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

Returns the true if the Nth array element is null, otherwise returns false. Indexing is 0-based (the 1st member is at index 0).

top
Load
boolean Load(String jsonArray);
Introduced in version 9.5.0.64

Loads a JSON array from a string. A JSON array must begin with a "[" and end with a "]".

Note: The Load method causes the JsonArray to detach and become it's own JSON document. It should only be called on new instances of the JsonArray. See the example below.

Returns true for success, false for failure.

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

Loads a JSON array from a StringBuilder. A JSON array must begin with a "[" and end with a "]".

Note: The Load method causes the JsonArray to detach and become it's own JSON document. It should only be called on new instances of the JsonArray. See the example below.

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 array element. Indexing is 0-based (the 1st member is at index 0).

Returns nil on 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 array element. Indexing is 0-based (the 1st member is at index 0).

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 array element. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

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

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

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 array element. 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
SetStringAt
boolean SetStringAt(int index, String value);
Introduced in version 9.5.0.56

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

Returns true for success, false for failure.

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 array element. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

top
Swap
boolean Swap(int index1, int index2);
Introduced in version 9.5.0.76

Swaps the items at positions index1 and index2.

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