com.zackehh.dotnotes

Class DotNotes

java.lang.Object

com.zackehh.dotnotes.DotNotes

public class DotNotes
extends Object

The public access for DotNotes. This class allows for manipulation of $JsonNodes being passed in, either flattening, inflating or processing recursively. Also provides access to several dot notation utility methods, such as key parsing.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DotNotes.NodeIterator A very small interface used for processing the iteration through a set of path and key tuples.

Method Summary

Modifier and Type	Method and Description
static com.fasterxml.jackson.databind.JsonNode	create(String path, com.fasterxml.jackson.databind.JsonNode value) A wrapper to $create(String, JsonNode, JsonNode), simply passing through parameters and appending `null` to the argument set.
static com.fasterxml.jackson.databind.JsonNode	create(String path, com.fasterxml.jackson.databind.JsonNode value, com.fasterxml.jackson.databind.JsonNode target) Uses a dot-noted path in order to create a given value in the given leaf of a tree.
static com.fasterxml.jackson.databind.JsonNode	get(String path, com.fasterxml.jackson.databind.JsonNode node) Uses a String path to create a List of keys in order to move through a nested $JsonNode in order to find a specific value.
static List<NotedKey>	keys(String s) Takes a dot-noted String and converts it to a List of keys.
static void	recurse(com.fasterxml.jackson.databind.JsonNode node, DotNotes.NodeIterator handler) A small wrapper to $recurse(JsonNode, NodeIterator, String) to allow omitting a third parameter, passing null instead.
static void	recurse(com.fasterxml.jackson.databind.JsonNode node, DotNotes.NodeIterator handler, String start) Moves through the provided JsonNode, emitting values to the $DotNotes.NodeIterator.execute(NotedKey, JsonNode, String) method of a provided handler.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static com.fasterxml.jackson.databind.JsonNode create(String path,
                                                             com.fasterxml.jackson.databind.JsonNode value)
                                                      throws ParseException

A wrapper to $create(String, JsonNode, JsonNode), simply passing through parameters and appending `null` to the argument set. It's a shorthand for lazy programmers (myself included).

Parameters:

path - the path to create

value - the value to set the path to

Returns:

the $JsonNode after key creation

Throws:

ParseException - if any parsing issues occur

create

public static com.fasterxml.jackson.databind.JsonNode create(String path,
                                                             com.fasterxml.jackson.databind.JsonNode value,
                                                             com.fasterxml.jackson.databind.JsonNode target)
                                                      throws ParseException

Uses a dot-noted path in order to create a given value in the given leaf of a tree. This can either create a new $JsonNode from scratch, or be used to populate a pre-existing one.

Parameters:

path - the path to create

value - the value to set the path to

target - the target $JsonNode to create into

Returns:

the $JsonNode after key creation

Throws:

ParseException - if any parsing issues occur

get

public static com.fasterxml.jackson.databind.JsonNode get(String path,
                                                          com.fasterxml.jackson.databind.JsonNode node)
                                                   throws ParseException

Uses a String path to create a List of keys in order to move through a nested $JsonNode in order to find a specific value. If the value is found, it is returned. If it can not be found, a $MissingNode will be returned.

Parameters:

path - the path to find the value for

node - the node to use for the search

Returns:

a $JsonNode if found, a $MissingNode if not

Throws:

ParseException - if any parsing issues occur

keys

public static List<NotedKey> keys(String s)
                           throws ParseException

Takes a dot-noted String and converts it to a List of keys. This method is by no means perfect, however it's stable enough for most usage. A List of $NotedKeys will be returned.

Parameters:

s - the String to parse

Returns:

a List of $NotedKeys

Throws:

ParseException - if any parsing issues occur

recurse

public static void recurse(com.fasterxml.jackson.databind.JsonNode node,
                           DotNotes.NodeIterator handler)

A small wrapper to $recurse(JsonNode, NodeIterator, String) to allow omitting a third parameter, passing null instead.

Parameters:

node - the node to pass

handler - the handler to pass

recurse

public static void recurse(com.fasterxml.jackson.databind.JsonNode node,
                           DotNotes.NodeIterator handler,
                           String start)

Moves through the provided JsonNode, emitting values to the $DotNotes.NodeIterator.execute(NotedKey, JsonNode, String) method of a provided handler. A prefix can be provided in order to start all paths with a custom prefix. Paths will not be generated if $DotNotes.NodeIterator.requirePathGeneration() returns false.

Parameters:

node - the node to iterate through

handler - the handler to emit to

start - the starting prefix String, if any