io.inversion.utils

Class JSArray

java.lang.Object

io.inversion.utils.JSNode

io.inversion.utils.JSArray

All Implemented Interfaces:

java.lang.Iterable, java.util.Map<java.lang.String,java.lang.Object>

public class JSArray
extends JSNode
implements java.lang.Iterable

Yet another JavaScript/JSON list object representation with a few superpowers.

JSArray extends JSNode and JSNode implements Map so it is impossible for JSArray to implement List but that is practically what is happening.

This builds on JSNode but instead of string based keys, the keys are integer index positions in an underlying List.

See Also:

JSNode

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List	objects The objects stored in this JSArray.

Constructor Summary

Constructors

Constructor and Description
JSArray(java.lang.Object... objects)

Method Summary

Modifier and Type	Method and Description
void	add(int index, java.lang.Object value) Overloading of set(int, Object)
void	add(java.lang.Object value) Adds object to the end of objects
void	addAll(JSArray array) Adds all elements from array to the end of objects
JSArray	asArray() Similar to #asList() but instead of returning a List, it returns a this JSNode as the only item in a JSArray.
java.util.List	asList() Returns this object as the only element in a list.
java.util.Map	asMap()
void	clear() Removes all properties
boolean	contains(java.lang.Object object)
java.lang.Object	get(int index) Gets the object at index and will not throw ArrayIndexOutOfBoundsException
java.lang.Object	get(java.lang.Object index) Override of JSNode.get(Object) to parse index as an Integer and pull from objects instead of JSNode.properties
JSArray	getArray(int index) Convenience overloading of get(Object)
boolean	getBoolean(int index) Convenience overloading of get(int)
double	getDouble(int index) Convenience overloading of get(Object)
int	getInt(int index) Convenience overloading of get(Object)
JSNode	getNode(int index) Convenience overloading of get(int)
java.lang.String	getString(int index) Convenience overloading of get(Object)
boolean	isArray() Easy alternative to 'instanceof' to differentiate JSNode from JSArray (which subclasses JSNode).
boolean	isEmpty()
java.util.Iterator	iterator()
java.util.Set<java.lang.String>	keySet()
int	length()
java.lang.Object	put(int index, java.lang.Object value) Overloading of put(String, Object) for completion, really just calls set(int, Object)
java.lang.Object	put(java.lang.String index, java.lang.Object value) Override of JSNode.put(String, Object) to parse index as an Integer and store the result in objects instead of JSNode.properties
java.lang.Object	remove(int index) Removes column index if it exists.
java.lang.Object	remove(java.lang.Object index) Override of JSNode.remove(Object) to parse index as an Integer and remove the column from objects instead of removing the key from JSNode.properties
java.lang.Object	set(int index, java.lang.Object value) Sets objects[index] to value expanding the size of objects as much as is required.
int	size()
java.util.Collection	values()

Methods inherited from class io.inversion.utils.JSNode

asNodeList, containsKey, containsValue, copy, diff, entrySet, find, findAll, findAll, findAllNodes, findArray, findBoolean, findDouble, findInt, findLong, findNode, findString, getArray, getBoolean, getDouble, getInt, getLong, getNode, getString, hasProperty, parseJson, parseJsonArray, parseJsonNode, patch, putAll, putFirst, removeAll, sortKeys, stream, streamAll, toString, toString, toString, with

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

objects

protected java.util.List objects

The objects stored in this JSArray.

This replaces the use of the JSNode.properties map from the superclass.

Constructor Detail

JSArray

public JSArray(java.lang.Object... objects)

Method Detail

isArray

public boolean isArray()

Description copied from class: JSNode

Easy alternative to 'instanceof' to differentiate JSNode from JSArray (which subclasses JSNode).

Overrides:

isArray in class JSNode

Returns:

true

See Also:

JSNode.isArray()

put

public java.lang.Object put(java.lang.String index,
                            java.lang.Object value)

Override of JSNode.put(String, Object) to parse index as an Integer and store the result in objects instead of JSNode.properties

Put/set/add are basically synonyms.

Specified by:

put in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

put in class JSNode

Returns:

the prior value at index

See Also:

set(int, Object)

put

public java.lang.Object put(int index,
                            java.lang.Object value)

Overloading of put(String, Object) for completion, really just calls set(int, Object)

Put/set/add are basically synonyms.

Parameters:

index - the zero based property index to store

value - a JSNode, JSArray, or compatible Java type

Returns:

the prior value at index

See Also:

set(int, Object)

set

public java.lang.Object set(int index,
                            java.lang.Object value)
                     throws java.lang.ArrayIndexOutOfBoundsException

Sets objects[index] to value expanding the size of objects as much as is required.

Put/set/add are basically synonyms.

Parameters:

index - the zero based property index to store

value - a JSNode, JSArray, or compatible Java type

Returns:

the prior value at index if it exists

Throws:

java.lang.ArrayIndexOutOfBoundsException - only if index is @lt; 0

add

public void add(int index,
                java.lang.Object value)

Overloading of set(int, Object)

Parameters:

index - the zero based property index to store

value - a JSNode, JSArray, or compatible Java type

add

public void add(java.lang.Object value)

Adds object to the end of objects

Parameters:

value - a JSNode, JSArray, or compatible Java type

addAll

public void addAll(JSArray array)

Adds all elements from array to the end of objects

Parameters:

array - an array of elements to add

remove

public java.lang.Object remove(java.lang.Object index)

Override of JSNode.remove(Object) to parse index as an Integer and remove the column from objects instead of removing the key from JSNode.properties

Specified by:

remove in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

remove in class JSNode

Parameters:

index - a value that should parse to an integer

Returns:

the prior value at index if it exits

See Also:

remove(int)

remove

public java.lang.Object remove(int index)

Removes column index if it exists.

Will not throw ArrayIndexOutOfBoundsException

Parameters:

index - the element/column to remove from objects

Returns:

the prior value at index if it exits

get

public java.lang.Object get(java.lang.Object index)

Override of JSNode.get(Object) to parse index as an Integer and pull from objects instead of JSNode.properties

Specified by:

get in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

get in class JSNode

Parameters:

index - the zero based property index to get

get

public java.lang.Object get(int index)

Gets the object at index and will not throw ArrayIndexOutOfBoundsException

Parameters:

index - the zero based property index to get

Returns:

the object at index if it exists else, null

getNode

public JSNode getNode(int index)
               throws java.lang.ClassCastException

Convenience overloading of get(int)

Parameters:

index - the zero based property index to get

Returns:

the value at index cast to a JSNode if exists else null

Throws:

java.lang.ClassCastException - if the object found is not a JSNode

See Also:

get(Object)

getArray

public JSArray getArray(int index)

Convenience overloading of get(Object)

Parameters:

index - the zero based property index to get

Returns:

the value at index cast to a JSArray if exists else null

Throws:

java.lang.ClassCastException - if the object found is not a JSArray

See Also:

get(Object)

getString

public java.lang.String getString(int index)

Convenience overloading of get(Object)

Parameters:

index - the zero based property index to get

Returns:

the value of property name stringified if it exists else null

See Also:

get(Object)

getInt

public int getInt(int index)

Convenience overloading of get(Object)

Parameters:

index - the zero based property index to get

Returns:

the value at index stringified and parsed as an int if it exists else -1

See Also:

get(Object)

getDouble

public double getDouble(int index)

Convenience overloading of get(Object)

Parameters:

index - the zero based property index to get

Returns:

the value at index stringified and parsed as a double if it exists else -1

See Also:

get(Object)

getBoolean

public boolean getBoolean(int index)

Convenience overloading of get(int)

Parameters:

index - the zero based property index to get

Returns:

the value at index stringified and parsed as a boolean if it exists else false

See Also:

get(Object)

keySet

public java.util.Set<java.lang.String> keySet()

Specified by:

keySet in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

keySet in class JSNode

asList

public java.util.List asList()

Description copied from class: JSNode

Returns this object as the only element in a list.

JSArray overrides this method to return all of its elements in a list.

This method is designed to make it super easy to iterate over all property values or array elements without having to cast or consider differences between JSNode and JSArray.

For example:

 JSNode node = response.getJson();//don't know if this is a JSNode or JSArray
 for(Object value : node.asList())
 {
    //do something;
 }
 

Overrides:

asList in class JSNode

Returns:

A List with this node as the only value.

See Also:

asList(), JSNode.asNodeList()

asArray

public JSArray asArray()

Description copied from class: JSNode

Similar to #asList() but instead of returning a List, it returns a this JSNode as the only item in a JSArray.

JSArray overrides this method to simply return 'this'.

Overrides:

asArray in class JSNode

Returns:

simply returns 'this';

See Also:

JSNode.asList(), JSNode.asNodeList(), asArray()

asMap

public java.util.Map asMap()

Overrides:

asMap in class JSNode

Returns:

a map of array index as strings to their value

contains

public boolean contains(java.lang.Object object)

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

isEmpty in class JSNode

Returns:

true if size() == 0

clear

public void clear()

Description copied from class: JSNode

Removes all properties

Specified by:

clear in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

clear in class JSNode

size

public int size()

Specified by:

size in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

size in class JSNode

Returns:

the number of properties on this node.

length

public int length()

iterator

public java.util.Iterator iterator()

Specified by:

iterator in interface java.lang.Iterable

values

public java.util.Collection values()

Specified by:

values in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

values in class JSNode

Returns:

a collection of property values