Package com.apicatalog.tree.io

Class TreeIO

java.lang.Object

com.apicatalog.tree.io.TreeIO

public class TreeIO
extends Object

Immutable representation of a tree node where the node and its descendants are accessed through a TreeAdapter.

A TreeIO instance binds a node with its adapter, providing a uniform way to traverse or compare trees of arbitrary underlying object models.

Pass a TreeIO from JSON, YAML, or CBOR into the tree to create polyformic tree composed of various different serializations, libraries, in order to uniformly prosses such a tree.

Field Summary

Fields

Modifier and Type	Field	Description
protected final TreeAdapter	adapter
protected final Object	node

Constructor Summary

Constructors

Constructor	Description
TreeIO(Object node, TreeAdapter adapter)	Creates a new immutable tree with the given root node and adapter.

Method Summary

Modifier and Type	Method	Description
TreeAdapter	adapter()
static Comparator<Object>	comparingElement(Function<Object,Comparable> keyExtractor)
static Comparator<Map.Entry<?,?>>	comparingEntry(Function<Map.Entry<?,?>,Comparable> keyExtractor)
static Comparator<?>	comparingNode(Function<Object,Comparable> keyExtractor)
static Comparator<Map.Entry<?,?>>	comparingStringKeys(TreeAdapter adapter)
static final boolean	deepEquals(TreeIO left, TreeIO right)
static final boolean	deepEquals(Object left, TreeAdapter leftAdapter, Object right, TreeAdapter rightAdapter)
protected static boolean	deepEqualsCollection(Iterable<? extends Object> left, TreeAdapter leftAdapter, Iterable<? extends Object> right, TreeAdapter rightAdapter)
boolean	isCollection()
static final boolean	isCollection(TreeIO node)
boolean	isEmptyOrNull()
static final boolean	isEmptyOrNull(TreeIO node)
boolean	isMap()
static final boolean	isMap(TreeIO node)
boolean	isSingleElement()
boolean	isSingleElement(TreeIO node)
boolean	isSingleEntry()
boolean	isSingleEntry(TreeIO node)
Collection<?>	keys()
Stream<?>	keyStream()
Object	node()	Root node, can be scalar or a structure like Map or Collection.
static final Object	property(Object key, TreeIO node)
Object	property(String key)
Object	singleElement()
Map.Entry<?,?>	singleEntry()
void	traverse(TreeGenerator generator)
void	traverse(Consumer<TreeTraversal> visitor)
NodeType	type()
static final NodeType	type(TreeIO node)

Methods inherited from class java.lang.Object

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

Field Details

adapter

protected final TreeAdapter adapter

node

protected final Object node

Constructor Details

TreeIO

public TreeIO(Object node,
 TreeAdapter adapter)

Creates a new immutable tree with the given root node and adapter.

Parameters:

node - the root node of the tree, must not be null

adapter - the adapter providing access to node types and values, must not be null

Throws:

NullPointerException - if root or adapter is null

Method Details

adapter

public TreeAdapter adapter()

node

public Object node()

Root node, can be scalar or a structure like Map or Collection.

Returns:

traverse

public void traverse(Consumer<TreeTraversal> visitor)

traverse

public void traverse(TreeGenerator generator)
              throws TreeIOException

Throws:

TreeIOException

deepEquals

public static final boolean deepEquals(TreeIO left,
 TreeIO right)

deepEquals

public static final boolean deepEquals(Object left,
 TreeAdapter leftAdapter,
 Object right,
 TreeAdapter rightAdapter)

deepEqualsCollection

protected static boolean deepEqualsCollection(Iterable<? extends Object> left,
 TreeAdapter leftAdapter,
 Iterable<? extends Object> right,
 TreeAdapter rightAdapter)

comparingEntry

public static Comparator<Map.Entry<?,?>> comparingEntry(Function<Map.Entry<?,?>,Comparable> keyExtractor)

comparingNode

public static Comparator<?> comparingNode(Function<Object,Comparable> keyExtractor)

comparingStringKeys

public static Comparator<Map.Entry<?,?>> comparingStringKeys(TreeAdapter adapter)

comparingElement

public static Comparator<Object> comparingElement(Function<Object,Comparable> keyExtractor)

isEmptyOrNull

public boolean isEmptyOrNull()

isEmptyOrNull

public static final boolean isEmptyOrNull(TreeIO node)

isMap

public boolean isMap()

isMap

public static final boolean isMap(TreeIO node)

property

public Object property(String key)

property

public static final Object property(Object key,
 TreeIO node)

isCollection

public boolean isCollection()

isCollection

public static final boolean isCollection(TreeIO node)

type

public NodeType type()

type

public static final NodeType type(TreeIO node)

isSingleElement

public boolean isSingleElement()

isSingleElement

public boolean isSingleElement(TreeIO node)

singleElement

public Object singleElement()

keys

public Collection<?> keys()

isSingleEntry

public boolean isSingleEntry()

isSingleEntry

public boolean isSingleEntry(TreeIO node)

singleEntry

public Map.Entry<?,?> singleEntry()

keyStream

public Stream<?> keyStream()