com.ak.json

Interface JNode

All Superinterfaces:

java.lang.Iterable<JNode>

All Known Subinterfaces:

JInstrumentalNode

All Known Implementing Classes:

AbstractJNode, JArrayNode, JObjectNode, JValueNode

public interface JNode
extends java.lang.Iterable<JNode>

Interface JNode represents operation are common for all types of node of tree.

Author:

krasnop@bellsouth.net (Alexei Krasnopolski)

Method Summary

Modifier and Type	Method and Description
<K,T extends JNode> void	addNode(K key, T node) Add element to composite node.
<T extends JNode> void	addNode(T node) Add element to composite node (without name).
JNode	clone() Return copy of this object, detached from node tree.
java.util.List<JNode>	getChildren() Returns set of all children of composite (Object or Array) node.
<K> JNode	getNode(K selector) Returns child node of this node by selector.
JNode	getParent() Return parent node of this node in node tree.
JNodeType	getType() Returns a type of the node.
<V> V	getValue() Return value of JValueNode.
<V> V	getValue(java.lang.Class<V> type) Return value of JValueNode.
java.util.Iterator<JNode>	iterator() Returns iterator over elements of composite node.
<K> void	removeNode(K selector) Remove child node of this node by selector.
<N extends JNode> void	removeNode(N node) Remove child node of this node.
<V> void	setValue(V value) Set value of V type for this node.
java.lang.String	toJson() Return this node as a JSON document.
java.lang.String	toString(java.lang.String indent, boolean showPath, boolean deep) Return printable (well formatted) text represents this node.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

getType

JNodeType getType()

Returns a type of the node.

Returns:

type of the node.

getNode

<K> JNode getNode(K selector)

Returns child node of this node by selector. If type of this node is JNodeType.ARRAY a selector has to be Integer type and represents index of the array member. If type of this node is JNodeType.OBJECT a selector has to be String and represents key of object property.

Type Parameters:

K - type of the selector: Integer or String.

Parameters:

selector - is index or key.

Returns:

JNode

addNode

<T extends JNode> void addNode(T node)

Add element to composite node (without name).

Type Parameters:

T - class of added node.

Parameters:

node - to be added.

addNode

<K,T extends JNode> void addNode(K key,
                                 T node)

Add element to composite node.

Type Parameters:

T - class of added node.

K - class of key (String for field name, Integer for node in JArray).

Parameters:

key - name of the field

node - to be added.

removeNode

<K> void removeNode(K selector)

Remove child node of this node by selector. If type of this node is JNodeType.ARRAY a selector has to be Integer type and represents index of the array member. If type of this node is JNodeType.OBJECT a selector has to be String and represents key of object property..

Type Parameters:

K - type of the selector: Integer or String.

Parameters:

selector - is index or key.

removeNode

<N extends JNode> void removeNode(N node)

Remove child node of this node.

Type Parameters:

N - type of node

Parameters:

node - to remove

getValue

<V> V getValue()

Return value of JValueNode.

Type Parameters:

V - type of value

Returns:

value of V type.

setValue

<V> void setValue(V value)

Set value of V type for this node.

Type Parameters:

V - type of value

Parameters:

value - to set for the node.

getValue

<V> V getValue(java.lang.Class<V> type)

Return value of JValueNode.

Type Parameters:

V - type of returned value: Integer, Boolean, Float, Double or String.

Parameters:

type - class that represents returned value.

Returns:

T

getParent

JNode getParent()

Return parent node of this node in node tree.

Returns:

JNode

toString

java.lang.String toString(java.lang.String indent,
                          boolean showPath,
                          boolean deep)

Return printable (well formatted) text represents this node.

Parameters:

indent - represent indentation for formatting text.

showPath - if true then the method insert path information in output.

deep - if true then the method will output children recursively.

Returns:

String

toJson

java.lang.String toJson()

Return this node as a JSON document.

Returns:

String

iterator

java.util.Iterator<JNode> iterator()

Returns iterator over elements of composite node.

Specified by:

iterator in interface java.lang.Iterable<JNode>

Returns:

Iterator<JNode> iterator

See Also:

Iterable

getChildren

java.util.List<JNode> getChildren()

Returns set of all children of composite (Object or Array) node.

Returns:

List<JNode>

clone

JNode clone()

Return copy of this object, detached from node tree.

Returns:

JNode