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(com.fasterxml.jackson.databind.JsonNode target, String path, com.fasterxml.jackson.databind.JsonNode value) Uses a dot-noted path in order to create a given value in the given leaf of a tree.
static String	escape(NotedKey key) Escapes a key input, to ensure that the returned String is a valid key format.
static String	escape(Number num) Wrapper to $escape(NotedKey) in order to allow easy passing of a Number value without having to manually force into a NotedKey.
static String	escape(String str) Wrapper to $escape(NotedKey) in order to allow easy passing of a String value without having to manually force into a NotedKey.
static com.fasterxml.jackson.databind.JsonNode	get(com.fasterxml.jackson.databind.JsonNode node, String path) 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 boolean	isEscaped(String key) Determines whether a String is already in an escaped format.
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(com.fasterxml.jackson.databind.JsonNode target,
                                                             String path,
                                                             com.fasterxml.jackson.databind.JsonNode value)
                                                      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:

target - the target $JsonNode to create into

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

escape

public static String escape(NotedKey key)
                     throws ParseException

Escapes a key input, to ensure that the returned String is a valid key format. This must take a $NotedKey instance in order to enforce Array vs Object typing.

Parameters:

key - the key to escape

Returns:

a $String with valid escaping

Throws:

ParseException

escape

public static String escape(Number num)
                     throws ParseException

Wrapper to $escape(NotedKey) in order to allow easy passing of a Number value without having to manually force into a NotedKey.

Parameters:

num - the number to pass

Returns:

the escaped String

Throws:

ParseException

escape

public static String escape(String str)
                     throws ParseException

Wrapper to $escape(NotedKey) in order to allow easy passing of a String value without having to manually force into a NotedKey.

Parameters:

str - the String to pass

Returns:

the escaped String

Throws:

ParseException

get

public static com.fasterxml.jackson.databind.JsonNode get(com.fasterxml.jackson.databind.JsonNode node,
                                                          String path)
                                                   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:

node - the node to use for the search

path - the path to find the value for

Returns:

a $JsonNode if found, a $MissingNode if not

Throws:

ParseException - if any parsing issues occur

isEscaped

public static boolean isEscaped(String key)

Determines whether a String is already in an escaped format. Returns true if this is the case. This does not validate dot notation, but rather it validates a single key.

Parameters:

key - the key to validate

Returns:

true if the key is escaped correctly

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