me.lucko.helper.datatree

Interface DataTree

All Known Implementing Classes:

ConfigurateDataTree, GsonDataTree

public interface DataTree

An easier way of parsing in-memory data structures.

Given the following example data:

 {
   "some-object": {
     "some-nested-object": {
       "a-string": "some special string",
       "a-boolean": true,
       "some-numbers": [4, 5, 7]
        }
   }
 }
 

Various elements could be parsed as:

• DataTree.from(root).resolve("some-object", "some-nested-object", "some-numbers", 2).asInt() would result in the value 5.
• DataTree.from(root).resolve("some-object", "some-nested-object").map(Map.Entry::getKey).toArray(String[]::new) would result in ["a-string", "a-boolean", "some-numbers"]

Methods always return a value, throwing an exception if a value isn't present or appropriate.

Method Summary

Modifier and Type	Method and Description
Stream<? extends DataTree>	asArray() Gets a stream of the member nodes, as if this tree was a JsonArray.
boolean	asBoolean() Returns a Boolean representation of this node.
double	asDouble() Returns a Double representation of this node.
Stream<? extends Map.Entry<Integer,? extends DataTree>>	asIndexedArray() Gets an indexed stream of the member nodes, as if this tree was a JsonArray.
int	asInt() Returns an Integer representation of this node.
Number	asNumber() Returns a Number representation of this node.
Stream<? extends Map.Entry<String,? extends DataTree>>	asObject() Gets a stream of the member nodes, as if this tree was a JsonObject.
String	asString() Returns a String representation of this node.
static ConfigurateDataTree	from(ninja.leaping.configurate.ConfigurationNode node) Creates a new DataTree from a ConfigurationNode.
static GsonDataTree	from(JsonElement element) Creates a new DataTree from a JsonElement.
DataTree	resolve(Object... path) Resolves the given path.

Method Detail

from

@Nonnull
static GsonDataTree from(@Nonnull
                                  JsonElement element)

Creates a new DataTree from a JsonElement.

Parameters:

element - the element

Returns:

a tree

from

@Nonnull
static ConfigurateDataTree from(@Nonnull
                                         ninja.leaping.configurate.ConfigurationNode node)

Creates a new DataTree from a ConfigurationNode.

Parameters:

node - the node

Returns:

a tree

resolve

@Nonnull
DataTree resolve(@Nonnull
                          Object... path)

Resolves the given path.

Paths can be made up of String or Integer components. Strings are used to resolve a member of an object, and integers resolve a member of an array.

Parameters:

path - the path

Returns:

the resultant tree node

asObject

@Nonnull
Stream<? extends Map.Entry<String,? extends DataTree>> asObject()

Gets a stream of the member nodes, as if this tree was a JsonObject.

Returns:

the members

asArray

@Nonnull
Stream<? extends DataTree> asArray()

Gets a stream of the member nodes, as if this tree was a JsonArray.

Returns:

the members

asIndexedArray

@Nonnull
Stream<? extends Map.Entry<Integer,? extends DataTree>> asIndexedArray()

Gets an indexed stream of the member nodes, as if this tree was a JsonArray.

Returns:

the members

asString

@Nonnull
String asString()

Returns a String representation of this node.

Returns:

this as a string

asNumber

@Nonnull
Number asNumber()

Returns a Number representation of this node.

Returns:

this as a number

asInt

int asInt()

Returns an Integer representation of this node.

Returns:

this as an integer

asDouble

double asDouble()

Returns a Double representation of this node.

Returns:

this as a double

asBoolean

boolean asBoolean()

Returns a Boolean representation of this node.

Returns:

this as a boolean