oracle.ifs.core.util

Class JsonArray

java.lang.Object

oracle.ifs.core.util.JsonElement

oracle.ifs.core.util.JsonArray

public class JsonArray
extends JsonElement

JsonArray holds a representation of a JSON array in a raw format.

Constructor Summary

Constructors

Constructor and Description
JsonArray() Constructs a JsonArray to be used in constructing a JSON representation.
JsonArray(JsonElement baseElement) Constructs a JsonArray from an existing JsonElement, using its parser and event list.
JsonArray(javax.json.stream.JsonParser jsonParser, List<String> eventList) Constructs a JsonArray.
JsonArray(List<AttributeValueTable> avtList) Constructs a JsonArray from a list of AttributeValueTable.
JsonArray(String[] stringVals) Constructs a JsonArray to represent an array of Strings.

Method Summary

Modifier and Type	Method and Description
void	add(boolean value) Adds a boolean value.
void	add(double value) Adds a double value.
void	add(JsonArray value) Adds a JsonArray value.
void	add(JsonObject value) Adds a JsonObject value.
void	add(long value) Adds a long value.
void	add(String value) Adds a String value.
void	addArray(JsonArray value) Adds a JsonArray value.
void	addElement(JsonElement value) Adds a JsonElement.
void	addNull() Adds a null value.
void	addObject(JsonObject value) Adds a JsonObject value.
void	addTable(AttributeValueTable avt) Adds a value from the specified AttributeValueTable.
void	addTableList(List<AttributeValueTable> avtList) Adds values from the specified list of AttributeValueTable.
void	addToTable(AttributeValueTable avt, String key) Add this JsonArray to the specified AttributeValueTable.
void	addValue(AttributeValue av) Adds a String, number, or boolean value (as an AttributeValue).
List<JsonArray>	getArrayList() Gets the object depiction as a list of JsonArray.
Boolean[]	getBooleanValueArray() Gets the value as an array of Boolean, if this object depicts a homogeneous set of Booleans.
Double[]	getDoubleValueArray() Gets the value as an array of Double, if this object depicts a homogeneous set of Doubles.
List<Object>	getElementList() Gets the object depiction as a list of Object, used for cases where the elements of the array are not homogeneous.
Long[]	getLongValueArray() Gets the value as an array of Long, if this object depicts a homogeneous set of Longs.
List<JsonObject>	getObjectList() Gets the object depiction as a list of JsonObject.
String[]	getStringValueArray() Gets the value as an array of String, if this object depicts a homogeneous set of Strings.
List<AttributeValue>	getValueList() Gets the object depiction as a list of AttributeValue.
boolean	isArrayList() Checks if this object depicts a list of JsonArray.
boolean	isBooleanValueList() Checks if this object depicts a list of Boolean AttributeValues.
boolean	isDoubleValueList() Checks if this object depicts a list of Double AttributeValues.
boolean	isLongValueList() Checks if this object depicts a list of Long AttributeValues.
boolean	isNullArray() Checks if this object depicts a null array (legal in JSON).
boolean	isObjectList() Checks if this object depicts a list of JsonObject.
boolean	isStringValueList() Checks if this object depicts a list of String AttributeValues.
boolean	isValueList() Checks if this object depicts a list of AttributeValue.
void	parseArray() Parses the array.
List<AttributeValueTable>	toAttributeValueTableList() Convert this object to a list of AttributeValueTable.
String	toString() Convert this object to JSON format.

Methods inherited from class oracle.ifs.core.util.JsonElement

contructBooleanValue, contructDoubleValue, contructLongValue, contructLongValue, contructStringValue, getJsonEventStringList, getJsonParser, getNextEvent, getValueAsJsonValue

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonArray

public JsonArray()

Constructs a JsonArray to be used in constructing a JSON representation.

JsonArray

public JsonArray(javax.json.stream.JsonParser jsonParser,
                 List<String> eventList)

Constructs a JsonArray.

Parameters:

jsonParser - the JSON parser being used to create this object

eventList - the event string list

JsonArray

public JsonArray(List<AttributeValueTable> avtList)
          throws IfsException

Constructs a JsonArray from a list of AttributeValueTable.

Parameters:

avtList - the list of AttributeValueTable

Throws:

IfsException

JsonArray

public JsonArray(JsonElement baseElement)

Constructs a JsonArray from an existing JsonElement, using its parser and event list.

Parameters:

baseElement - the JsonElement which holds the parser and event list

JsonArray

public JsonArray(String[] stringVals)

Constructs a JsonArray to represent an array of Strings.

Parameters:

stringVals - the String values comprising the array

Method Detail

getStringValueArray

public String[] getStringValueArray()
                             throws IfsException

Gets the value as an array of String, if this object depicts a homogeneous set of Strings.

Returns:

the array of String values, or null if the depiction is not a homogeneous array of String values (i.e. if isStringValueList() returns false)

Throws:

IfsException - if this operation fails

getBooleanValueArray

public Boolean[] getBooleanValueArray()
                               throws IfsException

Gets the value as an array of Boolean, if this object depicts a homogeneous set of Booleans.

Returns:

the array of Boolean values, or null if the depiction is not a homogeneous array of Boolean values (i.e. if isBooleanValueList() returns false)

Throws:

IfsException - if this operation fails

getLongValueArray

public Long[] getLongValueArray()
                         throws IfsException

Gets the value as an array of Long, if this object depicts a homogeneous set of Longs.

Returns:

the array of Long values, or null if the depiction is not a homogeneous array of Long values (i.e. if isLongValueList() returns false)

Throws:

IfsException - if this operation fails

getDoubleValueArray

public Double[] getDoubleValueArray()
                             throws IfsException

Gets the value as an array of Double, if this object depicts a homogeneous set of Doubles.

Returns:

the array of Double values, or null if the depiction is not a homogeneous array of Double values (i.e. if isDoubleValueList() returns false)

Throws:

IfsException - if this operation fails

getValueList

public List<AttributeValue> getValueList()

Gets the object depiction as a list of AttributeValue.

Returns:

the list of AttributeValue, or null if the depiction is not a homogeneous array of values (i.e. if isValueList() returns false)

getObjectList

public List<JsonObject> getObjectList()

Gets the object depiction as a list of JsonObject.

Returns:

the list of JsonObject, or null if the depiction is not a homogeneous array of JsonObject (i.e. if isObjectList() returns false)

getArrayList

public List<JsonArray> getArrayList()

Gets the object depiction as a list of JsonArray.

Returns:

the list of JsonArray, or null if the depiction is not a homogeneous array of JsonArray (i.e. if isArrayList() returns false)

getElementList

public List<Object> getElementList()

Gets the object depiction as a list of Object, used for cases where the elements of the array are not homogeneous.

Returns:

the list of elements

isStringValueList

public boolean isStringValueList()

Checks if this object depicts a list of String AttributeValues.

Returns:

true iff all elements are String values

isBooleanValueList

public boolean isBooleanValueList()

Checks if this object depicts a list of Boolean AttributeValues.

Returns:

true iff all elements are Boolean values

isLongValueList

public boolean isLongValueList()

Checks if this object depicts a list of Long AttributeValues.

Returns:

true iff all elements are Long values

isDoubleValueList

public boolean isDoubleValueList()

Checks if this object depicts a list of Double AttributeValues.

Returns:

true iff all elements are Double values

isValueList

public boolean isValueList()

Checks if this object depicts a list of AttributeValue.

Returns:

true iff all elements are values

isObjectList

public boolean isObjectList()

Checks if this object depicts a list of JsonObject.

Returns:

true iff all elements are JsonObjects

isArrayList

public boolean isArrayList()

Checks if this object depicts a list of JsonArray.

Returns:

true iff all elements are JsonArrays

isNullArray

public boolean isNullArray()

Checks if this object depicts a null array (legal in JSON).

Returns:

true iff this object depicts a null array

add

public void add(String value)

Adds a String value.

Parameters:

value - the String value

add

public void add(long value)

Adds a long value.

Parameters:

value - the long value

add

public void add(double value)

Adds a double value.

Parameters:

value - the double value

add

public void add(boolean value)

Adds a boolean value.

Parameters:

value - the boolean value

add

public void add(JsonObject value)

Adds a JsonObject value.

Parameters:

value - the JsonObject value

add

public void add(JsonArray value)

Adds a JsonArray value.

Parameters:

value - the JsonArray value

addNull

public void addNull()

Adds a null value.

addTable

public void addTable(AttributeValueTable avt)

Adds a value from the specified AttributeValueTable.

Parameters:

avt - the AttributeValueTable

addTableList

public void addTableList(List<AttributeValueTable> avtList)

Adds values from the specified list of AttributeValueTable.

Parameters:

avtList - the list of AttributeValueTables

addValue

public void addValue(AttributeValue av)

Adds a String, number, or boolean value (as an AttributeValue).

Parameters:

av - the AttributeValue

addObject

public void addObject(JsonObject value)

Adds a JsonObject value.

Parameters:

value - the JsonObject value

addArray

public void addArray(JsonArray value)

Adds a JsonArray value.

Parameters:

value - the JsonArray value

addElement

public void addElement(JsonElement value)

Adds a JsonElement.

Parameters:

value - the JsonElement value

toString

public String toString()

Convert this object to JSON format.

Overrides:

toString in class Object

Returns:

the JSON representation of this object (compressed form)

toAttributeValueTableList

public List<AttributeValueTable> toAttributeValueTableList()
                                                    throws IfsException

Convert this object to a list of AttributeValueTable.

Returns:

the AttributeValueTable list representation of this object

Throws:

IfsException - if this operation fails

addToTable

public void addToTable(AttributeValueTable avt,
                       String key)
                throws IfsException

Add this JsonArray to the specified AttributeValueTable.

Parameters:

avt - the AttributeValueTable

key - the key to use for the value

Throws:

IfsException - if this operation fails

parseArray

public void parseArray()

Parses the array.