|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.util.json.JSONValue
com.unboundid.util.json.JSONArray
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class JSONArray
This class provides an implementation of a JSON value that represents an
ordered collection of zero or more values. An array can contain elements of
any type, including a mix of types, and including nested arrays. The same
value may appear multiple times in an array.
The string representation of a JSON array is an open square bracket (U+005B)
followed by a comma-delimited list of the string representations of the
values in that array and a closing square bracket (U+005D). There must not
be a comma between the last item in the array and the closing square bracket.
There may optionally be any amount of whitespace (where whitespace characters
include the ASCII space, horizontal tab, line feed, and carriage return
characters) after the open square bracket, on either or both sides of commas
separating values, and before the close square bracket.
The string representation returned by the toString()
method (or
appended to the buffer provided to the toString(StringBuilder)
method) will include one space before each value in the array and one space
before the closing square bracket. There will not be any space between a
value and the comma that follows it. The string representation of each value
in the array will be obtained using that value's toString
method.
The normalized string representation will not include any optional spaces,
and the normalized string representation of each value in the array will be
obtained using that value's toNormalizedString
method.
Field Summary | |
---|---|
static JSONArray |
EMPTY_ARRAY
A pre-allocated empty JSON array. |
Constructor Summary | |
---|---|
JSONArray(JSONValue... values)
Creates a new JSON array with the provided values. |
|
JSONArray(java.util.List<? extends JSONValue> values)
Creates a new JSON array with the provided values. |
Method Summary | |
---|---|
void |
appendToJSONBuffer(JSONBuffer buffer)
Appends this value to the provided JSON buffer. |
void |
appendToJSONBuffer(java.lang.String fieldName,
JSONBuffer buffer)
Appends a field with the given name and this value to the provided JSON buffer. |
boolean |
contains(JSONValue value,
boolean ignoreFieldNameCase,
boolean ignoreValueCase,
boolean ignoreArrayOrder,
boolean recursive)
Indicates whether this JSON array contains an element with the specified value. |
boolean |
equals(JSONArray array,
boolean ignoreFieldNameCase,
boolean ignoreValueCase,
boolean ignoreArrayOrder)
Indicates whether this JSON array is considered equivalent to the provided array, subject to the specified constraints. |
boolean |
equals(JSONValue v,
boolean ignoreFieldNameCase,
boolean ignoreValueCase,
boolean ignoreArrayOrder)
Indicates whether this JSON value is considered equal to the provided JSON value, subject to the specified constraints. |
boolean |
equals(java.lang.Object o)
Indicates whether the provided object is equal to this JSON value. |
java.util.List<JSONValue> |
getValues()
Retrieves the set of values contained in this JSON array. |
int |
hashCode()
Retrieves a hash code for this JSON value. |
boolean |
isEmpty()
Indicates whether this array is empty. |
int |
size()
Retrieves the number of values contained in this array. |
java.lang.String |
toNormalizedString()
Retrieves a normalized string representation of this value. |
void |
toNormalizedString(java.lang.StringBuilder buffer)
Appends a normalized string representation of this value to the provided buffer. |
java.lang.String |
toSingleLineString()
Retrieves a single-line string representation of this value as it should appear in a JSON object, including any necessary quoting, escaping, etc. |
void |
toSingleLineString(java.lang.StringBuilder buffer)
Appends a single-line string representation of this value (as it should appear in a JSON object, including any necessary quoting, escaping, etc.) to the provided buffer. |
java.lang.String |
toString()
Retrieves a string representation of this value as it should appear in a JSON object, including any necessary quoting, escaping, etc. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this value (as it should appear in a JSON object, including any necessary quoting, escaping, etc.) to the provided buffer. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final JSONArray EMPTY_ARRAY
Constructor Detail |
---|
public JSONArray(JSONValue... values)
values
- The set of values to include in this JSON array. It may be
null
or empty to indicate that the array should be
empty.public JSONArray(java.util.List<? extends JSONValue> values)
values
- The set of values to include in this JSON array. It may be
null
or empty to indicate that the array should be
empty.Method Detail |
---|
public java.util.List<JSONValue> getValues()
public boolean isEmpty()
true
if this array does not contain any values, or
false
if this array contains at least one value.public int size()
public int hashCode()
hashCode
in class JSONValue
public boolean equals(java.lang.Object o)
equals
in class JSONValue
o
- The object to compare against this JSON value.
true
if the provided object is considered equal to this
JSON value, or false
if not.public boolean equals(JSONArray array, boolean ignoreFieldNameCase, boolean ignoreValueCase, boolean ignoreArrayOrder)
array
- The array for which to make the determination.ignoreFieldNameCase
- Indicates whether to ignore differences in
capitalization in field names for any JSON
objects contained in the array.ignoreValueCase
- Indicates whether to ignore differences in
capitalization for array elements that are
JSON strings, as well as for the string values
of any JSON objects and arrays contained in
the array.ignoreArrayOrder
- Indicates whether to ignore differences in the
order of elements contained in the array.
true
if this JSON array is considered equivalent to the
provided array (subject to the specified constraints), or
false
if not.public boolean equals(JSONValue v, boolean ignoreFieldNameCase, boolean ignoreValueCase, boolean ignoreArrayOrder)
equals
in class JSONValue
v
- The JSON value for which to make the
determination. It must not be null
.ignoreFieldNameCase
- Indicates whether to ignore differences in the
capitalization of JSON field names.ignoreValueCase
- Indicates whether to ignore differences in
the capitalization of JSON values that
represent strings.ignoreArrayOrder
- Indicates whether to ignore differences in the
order of elements in JSON arrays.
true
if this JSON value is considered equal to the
provided JSON value (subject to the specified constraints), or
false
if not.public boolean contains(JSONValue value, boolean ignoreFieldNameCase, boolean ignoreValueCase, boolean ignoreArrayOrder, boolean recursive)
value
- The value for which to make the determination.ignoreFieldNameCase
- Indicates whether to ignore differences in
capitalization in field names for any JSON
objects contained in the array.ignoreValueCase
- Indicates whether to ignore differences in
capitalization for array elements that are
JSON strings, as well as for the string values
of any JSON objects and arrays contained in
the array.ignoreArrayOrder
- Indicates whether to ignore differences in the
order of elements contained in arrays. This
is only applicable if the provided value is
itself an array or is a JSON object that
contains values that are arrays.recursive
- Indicates whether to recursively look into any
arrays contained inside this array.
true
if this JSON array contains an element with the
specified value, or false
if not.public java.lang.String toString()
toString
in class JSONValue
public void toString(java.lang.StringBuilder buffer)
toString
in class JSONValue
buffer
- The buffer to which the information should be appended.public java.lang.String toSingleLineString()
toSingleLineString
in class JSONValue
public void toSingleLineString(java.lang.StringBuilder buffer)
toSingleLineString
in class JSONValue
buffer
- The buffer to which the information should be appended.public java.lang.String toNormalizedString()
toNormalizedString
in class JSONValue
public void toNormalizedString(java.lang.StringBuilder buffer)
toNormalizedString
in class JSONValue
buffer
- The buffer to which the information should be appended.public void appendToJSONBuffer(JSONBuffer buffer)
appendToJSONBuffer
in class JSONValue
buffer
- The JSON buffer to which this value should be appended.public void appendToJSONBuffer(java.lang.String fieldName, JSONBuffer buffer)
appendToJSONBuffer
in class JSONValue
fieldName
- The name to use for the field.buffer
- The JSON buffer to which this value should be appended.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |