com.bazaarvoice.jolt.utils

Class JoltUtils

java.lang.Object

com.bazaarvoice.jolt.utils.JoltUtils

public class JoltUtils
extends Object

Handy utilities that do NOT depend on JsonUtil lives here!

Constructor Summary

Constructors

Constructor and Description
JoltUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static <T> T	cast(Object object) Type casts an input object to class indicated by TypeToken
static <E> E[]	cast(Object[] object) Type cast to array E[]
static boolean	isEmptyJson(Object obj) Given a json document, checks if it has any "leaf" values, can handle deep nesting of lists and maps i.e.
static List<Object[]>	listKeyChains(Object source) Given a json document, finds out absolute path to every leaf element i.e.
static List<Object[]>	listKeyChains(Object key, Object value) Helper/overridden method for listKeyChain(source), it accepts a key-value pair for convenience note: "key": value (an item in map) and [value] (an item in list) is generalized here as [value] is interpreted in json path as 1: value
static <T> T	navigate(Object source, Object... paths) Navigate inside a json object in quick and dirty way.
static <T> T	navigateSafe(T defaultValue, Object source, Object... paths) Navigate inside a json object in quick and "dirtier" way, i.e.
static void	removeRecursive(Object json, String keyToRemove) Removes a key recursively from anywhere in a JSON document.
static String	toSimpleTraversrPath(Object[] paths) Converts a standard json path to human readable SimpleTraversr compatible path

Methods inherited from class java.lang.Object

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

Constructor Detail

JoltUtils

public JoltUtils()

Method Detail

removeRecursive

public static void removeRecursive(Object json,
                   String keyToRemove)

Removes a key recursively from anywhere in a JSON document. NOTE: mutates its input.

Parameters:

json - the Jackson Object version of the JSON document (contents changed by this call)

keyToRemove - the key to remove from the document

navigate

public static <T> T navigate(Object source,
             Object... paths)

Navigate inside a json object in quick and dirty way.

Parameters:

source - the source json object

paths - the paths array to travel

Returns:

the object of Type at final destination

Throws:

NullPointerException - if the source is null

UnsupportedOperationException - if the source is not Map or List

navigateSafe

public static <T> T navigateSafe(T defaultValue,
                 Object source,
                 Object... paths)

Navigate inside a json object in quick and "dirtier" way, i.e. returns a default value NPE or out-of-index errors encountered

Parameters:

source - the source

paths - the paths array

Returns:

the object of Type at final destination or defaultValue if non existent

Throws:

UnsupportedOperationException - the unsupported operation exception

isEmptyJson

public static boolean isEmptyJson(Object obj)

Given a json document, checks if it has any "leaf" values, can handle deep nesting of lists and maps i.e. { "a": [ "x": {}, "y": [] ], "b": { "p": [], "q": {} }} ==> is empty

Parameters:

obj - source

Returns:

true if its an empty json, can have deep nesting, false otherwise

listKeyChains

public static List<Object[]> listKeyChains(Object source)

Given a json document, finds out absolute path to every leaf element i.e. { "a": [ "x": { "y": "alpha" }], "b": { "p": [ "beta", "gamma" ], "q": {} }} will yield 1) "a",0,"x","y" -> to "alpha" 2) "b","p", 0 -> to "beta" 3) "b", "p", 1 -> to "gamma" 4) "b","q" -> to {} (empty Map)

Parameters:

source - json

Returns:

list of Object[] representing path to every leaf element

listKeyChains

public static List<Object[]> listKeyChains(Object key,
                           Object value)

Helper/overridden method for listKeyChain(source), it accepts a key-value pair for convenience note: "key": value (an item in map) and [value] (an item in list) is generalized here as [value] is interpreted in json path as 1: value

Parameters:

key -

value -

Returns:

list of Object[] representing path to every leaf element starting with provided root key

toSimpleTraversrPath

public static String toSimpleTraversrPath(Object[] paths)

Converts a standard json path to human readable SimpleTraversr compatible path

Parameters:

paths - the path array of objects

Returns:

string representation of the path, human readable and SimpleTraversr friendly

cast

public static <T> T cast(Object object)

Type casts an input object to class indicated by TypeToken

Parameters:

object - the input object to cast

Returns:

cast object of type T

cast

public static <E> E[] cast(Object[] object)

Type cast to array E[]

Parameters:

object - the input object to cast

Returns:

casted array of type E[]