Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- adapt(Object, TreeAdapter) - Static method in class com.apicatalog.tree.io.java.NativeAdapter
- adapter - Variable in class com.apicatalog.tree.io.TreeIO
- adapter() - Method in class com.apicatalog.tree.io.TreeIO
- adapter() - Method in class com.apicatalog.tree.io.TreeTraversal
-
Gets the adapter to process the
#currentNode(). - adapters - Variable in class com.apicatalog.tree.io.TreeTraversal
- asCollection(Object) - Static method in class com.apicatalog.tree.io.java.NativeAdapter
- asDecimal(Object) - Method in class com.apicatalog.tree.io.java.NativeAdapter
- asDecimal(Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
-
Converts a given node to a
BigDecimal, if possible. - asIterable(Object) - Method in class com.apicatalog.tree.io.java.NativeAdapter
- asIterable(Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
-
Returns the node's contents as a universal
Iterable. - asStream(Object) - Method in class com.apicatalog.tree.io.java.NativeAdapter
- asStream(Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
-
Returns the node's contents as a universal
Stream. - asString(Object) - Method in class com.apicatalog.tree.io.java.NativeAdapter
- asString(Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
-
Returns a string representation of the node, coercing non-string scalar types where applicable.
B
- beginList() - Method in class com.apicatalog.tree.io.java.NativeMaterializer
-
Begins a new list (or array) structure.
- beginList() - Method in interface com.apicatalog.tree.io.TreeGenerator
-
Begins a new list (or array) structure.
- beginMap() - Method in class com.apicatalog.tree.io.java.NativeMaterializer
-
Begins a new map (or object) structure.
- beginMap() - Method in interface com.apicatalog.tree.io.TreeGenerator
-
Begins a new map (or object) structure.
- beginSet() - Method in class com.apicatalog.tree.io.java.NativeMaterializer
-
Begins a new set structure.
- beginSet() - Method in interface com.apicatalog.tree.io.TreeGenerator
-
Begins a new set structure.
- BINARY - Enum constant in enum class com.apicatalog.tree.io.NodeType
-
Binary scalar value, typically a byte sequence or encoded binary content.
- binaryValue(byte[]) - Method in class com.apicatalog.tree.io.java.NativeMaterializer
-
Adds a binary data value to the current context.
- binaryValue(byte[]) - Method in interface com.apicatalog.tree.io.TreeGenerator
-
Adds a binary data value to the current context.
- binaryValue(Object) - Method in class com.apicatalog.tree.io.java.NativeAdapter
- binaryValue(Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
-
Extracts the binary data from a binary node.
- booleanValue(boolean) - Method in class com.apicatalog.tree.io.java.NativeMaterializer
-
Adds a boolean value to the current context.
- booleanValue(boolean) - Method in interface com.apicatalog.tree.io.TreeGenerator
-
Adds a boolean value to the current context.
C
- COLLECTION - Enum constant in enum class com.apicatalog.tree.io.NodeType
-
Ordered sequence of elements, such as a JSON array or list.
- COLLECTION_ELEMENT - Enum constant in enum class com.apicatalog.tree.io.TreeTraversal.Context
-
The current node is an element within a collection structure.
- com.apicatalog.tree.io - package com.apicatalog.tree.io
-
Provides a flexible, format-agnostic framework for processing tree-like data structures.
- com.apicatalog.tree.io.java - package com.apicatalog.tree.io.java
- comparingElement(Function<Object, Comparable>) - Static method in class com.apicatalog.tree.io.TreeIO
- comparingEntry(Function<Map.Entry<?, ?>, Comparable>) - Static method in class com.apicatalog.tree.io.TreeIO
- comparingNode(Function<Object, Comparable>) - Static method in class com.apicatalog.tree.io.TreeIO
- comparingStringKeys(TreeAdapter) - Static method in class com.apicatalog.tree.io.TreeIO
- contains(Features) - Method in class com.apicatalog.tree.io.Features
- currentNode - Variable in class com.apicatalog.tree.io.TreeTraversal
- currentNodeContext - Variable in class com.apicatalog.tree.io.TreeTraversal
- currentNodeType - Variable in class com.apicatalog.tree.io.TreeTraversal
D
- decimalValue(Object) - Method in class com.apicatalog.tree.io.java.NativeAdapter
- decimalValue(Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
-
Extracts the
BigDecimalvalue from a numeric node. - deepEquals(TreeIO, TreeIO) - Static method in class com.apicatalog.tree.io.TreeIO
- deepEquals(Object, TreeAdapter, Object, TreeAdapter) - Static method in class com.apicatalog.tree.io.TreeIO
- deepEqualsCollection(Iterable<? extends Object>, TreeAdapter, Iterable<? extends Object>, TreeAdapter) - Static method in class com.apicatalog.tree.io.TreeIO
- depth - Variable in class com.apicatalog.tree.io.TreeTraversal
- doubleValue(Object) - Method in class com.apicatalog.tree.io.java.NativeAdapter
- doubleValue(Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
-
Extracts the
doublevalue from a numeric node.
E
- elements(Object) - Method in class com.apicatalog.tree.io.java.NativeAdapter
- elements(Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
-
Returns the elements of a collection node as an
Iterable. - elementStream(Object) - Method in class com.apicatalog.tree.io.java.NativeAdapter
- elementStream(Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
-
Returns the elements of a collection node as a
Stream. - end() - Method in class com.apicatalog.tree.io.java.NativeMaterializer
-
Ends the current map or collection structure.
- end() - Method in interface com.apicatalog.tree.io.TreeGenerator
-
Ends the current map or collection structure.
- END - Enum constant in enum class com.apicatalog.tree.io.TreeTraversal.Context
-
A synthetic marker indicating the end of a map or collection has been reached.
- entries(Object) - Method in class com.apicatalog.tree.io.java.NativeAdapter
- entries(Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
-
Returns all key-value pairs of a map node as an
Iterable. - entryComparator - Variable in class com.apicatalog.tree.io.TreeTraversal
- entryStream(Object) - Method in class com.apicatalog.tree.io.java.NativeAdapter
- entryStream(Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
-
Returns all key-value pairs of a map node as a
Stream.
F
- FALSE - Enum constant in enum class com.apicatalog.tree.io.NodeType
-
Boolean literal
false. - features() - Method in class com.apicatalog.tree.io.java.NativeAdapter
- features() - Method in class com.apicatalog.tree.io.java.NativeMaterializer
- features() - Method in interface com.apicatalog.tree.io.TreeAdapter
- features() - Method in interface com.apicatalog.tree.io.TreeGenerator
- Features - Class in com.apicatalog.tree.io
- Features(Set<NodeType>, Set<NodeType>) - Constructor for class com.apicatalog.tree.io.Features
I
- instance() - Static method in class com.apicatalog.tree.io.java.NativeAdapter
- integerValue(Object) - Method in class com.apicatalog.tree.io.java.NativeAdapter
- integerValue(Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
-
Extracts the
BigIntegervalue from a numeric node. - intValue(Object) - Method in class com.apicatalog.tree.io.java.NativeAdapter
- intValue(Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
-
Extracts the
intvalue from a numeric node. - isBinary(Object) - Method in class com.apicatalog.tree.io.java.NativeAdapter
- isBinary(Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
-
Checks if the adapted node contains binary data.
- isBoolean(Object) - Method in class com.apicatalog.tree.io.java.NativeAdapter
- isBoolean(Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
-
Checks if the adapted node represents a boolean value.
- isCollection() - Method in class com.apicatalog.tree.io.TreeIO
- isCollection(TreeIO) - Static method in class com.apicatalog.tree.io.TreeIO
- isCollection(Object) - Method in class com.apicatalog.tree.io.java.NativeAdapter
- isCollection(Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
-
Checks if the adapted node represents a collection of elements (e.g., an array or list).
- isCompatibleWith(TreeAdapter) - Method in interface com.apicatalog.tree.io.TreeAdapter
- isEmpty(Object) - Method in class com.apicatalog.tree.io.java.NativeAdapter
- isEmpty(Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
-
Checks if a map or collection node is empty.
- isEmptyCollection(Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
- isEmptyMap(Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
- isEmptyOrNull() - Method in class com.apicatalog.tree.io.TreeIO
- isEmptyOrNull(TreeIO) - Static method in class com.apicatalog.tree.io.TreeIO
- isFalse(Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
- isIntegral(Object) - Method in class com.apicatalog.tree.io.java.NativeAdapter
- isIntegral(Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
-
Checks if a number node represents an integral value (e.g., an integer or long) as opposed to a floating-point value.
- isList(Object) - Method in class com.apicatalog.tree.io.java.NativeAdapter
- isList(Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
-
Checks if the adapted collection node is a list (an ordered collection that allows duplicates).
- isMap() - Method in class com.apicatalog.tree.io.TreeIO
- isMap(TreeIO) - Static method in class com.apicatalog.tree.io.TreeIO
- isMap(Object) - Method in class com.apicatalog.tree.io.java.NativeAdapter
- isMap(Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
-
Checks if the adapted node represents a map (an object with key-value pairs).
- isNode(Object) - Method in class com.apicatalog.tree.io.java.NativeAdapter
- isNode(Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
-
Checks if the given object is a native node that this adapter can process.
- isNull(Object) - Method in class com.apicatalog.tree.io.java.NativeAdapter
- isNull(Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
-
Checks if the adapted node represents a null value.
- isNumber(Object) - Method in class com.apicatalog.tree.io.java.NativeAdapter
- isNumber(Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
-
Checks if the adapted node represents any numeric value (integral or floating-point).
- isScalar() - Method in enum class com.apicatalog.tree.io.NodeType
-
Returns whether this node type represents a scalar value.
- isSet(Object) - Method in class com.apicatalog.tree.io.java.NativeAdapter
- isSet(Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
-
Checks if the adapted collection node is a set (an unordered collection of unique elements).
- isSingleElement() - Method in class com.apicatalog.tree.io.TreeIO
- isSingleElement(TreeIO) - Method in class com.apicatalog.tree.io.TreeIO
- isSingleElement(Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
- isSingleEntry() - Method in class com.apicatalog.tree.io.TreeIO
- isSingleEntry(TreeIO) - Method in class com.apicatalog.tree.io.TreeIO
- isSingleEntry(Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
- isString(Object) - Method in class com.apicatalog.tree.io.java.NativeAdapter
- isString(Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
-
Checks if the adapted node represents a string value.
- isStructure() - Method in enum class com.apicatalog.tree.io.NodeType
-
Returns whether this node type represents a structural container.
- isTrue(Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
K
- keys() - Method in class com.apicatalog.tree.io.Features
-
Returns the set of scalar types that are supported as keys in map nodes.
- keys() - Method in class com.apicatalog.tree.io.TreeIO
- keys(Object) - Method in class com.apicatalog.tree.io.java.NativeAdapter
- keys(Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
-
Returns a collection of the native key objects from a map node.
- keyStream() - Method in class com.apicatalog.tree.io.TreeIO
- keyStream(Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
L
- longValue(Object) - Method in class com.apicatalog.tree.io.java.NativeAdapter
- longValue(Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
-
Extracts the
longvalue from a numeric node.
M
- MAP - Enum constant in enum class com.apicatalog.tree.io.NodeType
-
Mapping structure of key-value pairs, such as a JSON object or dictionary-like node.
- maxDepth - Variable in class com.apicatalog.tree.io.TreeTraversal
- maxDepth() - Method in class com.apicatalog.tree.io.TreeTraversal
-
Gets the configured maximum traversal depth.
- maxDepth(int) - Method in class com.apicatalog.tree.io.TreeTraversal
-
Sets the maximum traversal depth.
- maxVisited - Variable in class com.apicatalog.tree.io.TreeTraversal
- maxVisited() - Method in class com.apicatalog.tree.io.TreeTraversal
-
Gets the configured maximum number of nodes to visit.
- maxVisited(int) - Method in class com.apicatalog.tree.io.TreeTraversal
-
Sets the maximum number of nodes to visit.
N
- NativeAdapter - Class in com.apicatalog.tree.io.java
- NativeAdapter() - Constructor for class com.apicatalog.tree.io.java.NativeAdapter
- NativeMaterializer - Class in com.apicatalog.tree.io.java
-
A specialized class that builds a native object model from any tree-like source.
- NativeMaterializer() - Constructor for class com.apicatalog.tree.io.java.NativeMaterializer
- next() - Method in class com.apicatalog.tree.io.TreeTraversal
-
Advances the traversal to the next node in the depth-first sequence.
- next(TreeTraversal.Context) - Method in class com.apicatalog.tree.io.TreeTraversal
- node - Variable in class com.apicatalog.tree.io.TreeIO
- node() - Method in class com.apicatalog.tree.io.TreeIO
-
Root node, can be scalar or a structure like Map or Collection.
- node() - Method in class com.apicatalog.tree.io.TreeTraversal
-
Gets the current node being processed.
- node(TreeIO) - Static method in class com.apicatalog.tree.io.java.NativeMaterializer
- node(Object, TreeAdapter) - Static method in class com.apicatalog.tree.io.java.NativeMaterializer
- nodeContext() - Method in class com.apicatalog.tree.io.TreeTraversal
-
Gets the context of the current node.
- nodes() - Method in class com.apicatalog.tree.io.Features
-
Returns the complete set of node types that this adapter is capable of representing.
- nodeType() - Method in class com.apicatalog.tree.io.TreeTraversal
-
Gets the type of the current node.
- NodeType - Enum Class in com.apicatalog.tree.io
-
Enumeration of supported node types within a
PolyMorphtree structure. - NULL - Enum constant in enum class com.apicatalog.tree.io.NodeType
-
Null literal value.
- nullValue() - Method in class com.apicatalog.tree.io.java.NativeMaterializer
-
Adds a null value to the current context.
- nullValue() - Method in interface com.apicatalog.tree.io.TreeGenerator
-
Adds a null value to the current context.
- NUMBER - Enum constant in enum class com.apicatalog.tree.io.NodeType
-
Numeric scalar value.
- numericValue(double) - Method in class com.apicatalog.tree.io.java.NativeMaterializer
-
Adds a double-precision floating-point value to the current context.
- numericValue(double) - Method in interface com.apicatalog.tree.io.TreeGenerator
-
Adds a double-precision floating-point value to the current context.
- numericValue(long) - Method in class com.apicatalog.tree.io.java.NativeMaterializer
-
Adds a long integer value.
- numericValue(long) - Method in interface com.apicatalog.tree.io.TreeGenerator
-
Adds a long integer value.
- numericValue(Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
- numericValue(BigDecimal) - Method in class com.apicatalog.tree.io.java.NativeMaterializer
-
Adds an arbitrary-precision decimal value to the current context.
- numericValue(BigDecimal) - Method in interface com.apicatalog.tree.io.TreeGenerator
-
Adds an arbitrary-precision decimal value to the current context.
- numericValue(BigInteger) - Method in class com.apicatalog.tree.io.java.NativeMaterializer
-
Adds an arbitrary-precision integer value.
- numericValue(BigInteger) - Method in interface com.apicatalog.tree.io.TreeGenerator
-
Adds an arbitrary-precision integer value.
O
- object - Variable in class com.apicatalog.tree.io.java.NativeMaterializer
- object() - Method in class com.apicatalog.tree.io.java.NativeMaterializer
-
Returns the fully materialized
Objectafter a successful traversal.
P
- parse(InputStream) - Method in interface com.apicatalog.tree.io.TreeParser
- property(Object, TreeAdapter, Object) - Method in class com.apicatalog.tree.io.java.NativeAdapter
- property(Object, TreeAdapter, Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
- property(Object, TreeIO) - Static method in class com.apicatalog.tree.io.TreeIO
- property(Object, Object) - Method in class com.apicatalog.tree.io.java.NativeAdapter
- property(Object, Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
-
Retrieves the value associated with a given native key object from a map node.
- property(String) - Method in class com.apicatalog.tree.io.TreeIO
- PROPERTY_KEY - Enum constant in enum class com.apicatalog.tree.io.TreeTraversal.Context
-
The current node is a key within a map structure.
- PROPERTY_VALUE - Enum constant in enum class com.apicatalog.tree.io.TreeTraversal.Context
-
The current node is a value associated with a key in a map structure.
R
- render(Object, TreeAdapter, OutputStream) - Method in interface com.apicatalog.tree.io.TreeRenderer
- reset() - Method in class com.apicatalog.tree.io.java.NativeMaterializer
-
Resets the visitor's internal state, clearing the traversal stack and counters.
- reset() - Method in class com.apicatalog.tree.io.TreeTraversal
-
Resets the visitor's internal state, clearing the traversal stack and counters.
- root(Object, TreeAdapter) - Method in class com.apicatalog.tree.io.TreeTraversal
-
Sets the root node for the traversal, initializing the visitor's stack.
- ROOT - Enum constant in enum class com.apicatalog.tree.io.TreeTraversal.Context
-
The current node is the root of the tree being traversed.
S
- scalar(Object, TreeAdapter) - Static method in class com.apicatalog.tree.io.java.NativeMaterializer
- singleElement() - Method in class com.apicatalog.tree.io.TreeIO
- singleElement(Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
- singleEntry() - Method in class com.apicatalog.tree.io.TreeIO
- singleEntry(Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
- size(Object) - Method in class com.apicatalog.tree.io.java.NativeAdapter
- size(Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
-
Deprecated.
- stack - Variable in class com.apicatalog.tree.io.TreeTraversal
- STRING - Enum constant in enum class com.apicatalog.tree.io.NodeType
-
Textual scalar value.
- stringValue(Object) - Method in class com.apicatalog.tree.io.java.NativeAdapter
- stringValue(Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
-
Extracts the string value from a string node.
- stringValue(String) - Method in class com.apicatalog.tree.io.java.NativeMaterializer
-
Adds a string value.
- stringValue(String) - Method in interface com.apicatalog.tree.io.TreeGenerator
-
Adds a string value.
- structure(Object, TreeAdapter) - Method in class com.apicatalog.tree.io.java.NativeMaterializer
-
The primary entry point for materialization.
- structures - Variable in class com.apicatalog.tree.io.java.NativeMaterializer
T
- traverse(TreeGenerator) - Method in class com.apicatalog.tree.io.TreeIO
- traverse(TreeGenerator) - Method in class com.apicatalog.tree.io.TreeTraversal
-
A high-level utility method that fully traverses the tree and drives the provided
TreeGenerator. - traverse(Consumer<TreeTraversal>) - Method in class com.apicatalog.tree.io.TreeIO
- traverse(Consumer<TreeTraversal>) - Method in class com.apicatalog.tree.io.TreeTraversal
- TREE_IO - Enum constant in enum class com.apicatalog.tree.io.NodeType
-
Polymorphic wrapper node enabling heterogeneous access across formats.
- TreeAdapter - Interface in com.apicatalog.tree.io
-
Provides a uniform, read-only abstraction for navigating tree-like data structures.
- TreeGenerator - Interface in com.apicatalog.tree.io
-
Provides a uniform, event-based abstraction for constructing tree-like data structures.
- TreeIO - Class in com.apicatalog.tree.io
-
Immutable representation of a tree node where the node and its descendants are accessed through a
TreeAdapter. - TreeIO(Object, TreeAdapter) - Constructor for class com.apicatalog.tree.io.TreeIO
-
Creates a new immutable tree with the given root node and adapter.
- TreeIOException - Exception in com.apicatalog.tree.io
-
Exception thrown when a node cannot be read, written, or generated by a
NodeReader,NodeWriter, orNodeGenerator. - TreeIOException(Throwable) - Constructor for exception com.apicatalog.tree.io.TreeIOException
- TreeParser - Interface in com.apicatalog.tree.io
- TreeRenderer - Interface in com.apicatalog.tree.io
- TreeTraversal - Class in com.apicatalog.tree.io
-
Provides a stateful, non-recursive, depth-first iterator for arbitrary tree-like structures.
- TreeTraversal() - Constructor for class com.apicatalog.tree.io.TreeTraversal
- TreeTraversal(Deque<Object>) - Constructor for class com.apicatalog.tree.io.TreeTraversal
- TreeTraversal(Deque<Object>, Comparator<Map.Entry<?, ?>>) - Constructor for class com.apicatalog.tree.io.TreeTraversal
- TreeTraversal.Context - Enum Class in com.apicatalog.tree.io
-
Identifies the role of the current node within the tree structure during traversal.
- TRUE - Enum constant in enum class com.apicatalog.tree.io.NodeType
-
Boolean literal
true. - type() - Method in class com.apicatalog.tree.io.TreeIO
- type(TreeIO) - Static method in class com.apicatalog.tree.io.TreeIO
- type(Object) - Method in class com.apicatalog.tree.io.java.NativeAdapter
- type(Object) - Method in interface com.apicatalog.tree.io.TreeAdapter
-
Determines the
NodeTypeof the given native node.
U
- UNLIMITED_DEPTH - Static variable in class com.apicatalog.tree.io.TreeTraversal
-
A sentinel value indicating that traversal depth is not limited.
- UNLIMITED_NODES - Static variable in class com.apicatalog.tree.io.TreeTraversal
-
A sentinel value indicating that the number of visited nodes is not limited.
V
- value(Object) - Method in class com.apicatalog.tree.io.java.NativeMaterializer
-
Internal dispatcher that places a newly created
Objectinto the correct position within the structure being built. - valueOf(String) - Static method in enum class com.apicatalog.tree.io.NodeType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.apicatalog.tree.io.TreeTraversal.Context
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.apicatalog.tree.io.NodeType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.apicatalog.tree.io.TreeTraversal.Context
-
Returns an array containing the constants of this enum class, in the order they are declared.
- visited - Variable in class com.apicatalog.tree.io.TreeTraversal
- visited() - Method in class com.apicatalog.tree.io.TreeTraversal
-
Gets the total number of nodes visited so far.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form