Module com.github.wnameless.json.flattener

Package com.github.wnameless.json.unflattener

Class JsonUnflattener

java.lang.Object

com.github.wnameless.json.unflattener.JsonUnflattener

public final class JsonUnflattener
extends Object

JsonUnflattener provides a static unflatten(String) method to unflatten any flattened JSON string back to nested one.

Author:

Wei-Ming Wu

Constructor Summary

Constructors

Constructor	Description
JsonUnflattener(Reader jsonReader)	Creates a JSON unflattener.
JsonUnflattener(String json)	Creates a JSON unflattener.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
int	hashCode()
String	toString()
String	unflatten()	Returns a JSON string of nested objects by the given flattened JSON string.
static String	unflatten(String json)	Returns a JSON string of nested objects by the given flattened JSON string.
JsonUnflattener	withFlattenMode(FlattenMode flattenMode)	A fluent setter to setup a mode of the JsonUnflattener.
JsonUnflattener	withKeyTransformer(KeyTransformer keyTrans)	A fluent setter to setup a KeyTransformer of the JsonUnflattener.
JsonUnflattener	withLeftAndRightBrackets(char leftBracket, char rightBracket)	A fluent setter to setup the left and right brackets within a key in the flattened JSON.
JsonUnflattener	withPrintMode(PrintMode printMode)	A fluent setter to setup a print mode of the JsonUnflattener.
JsonUnflattener	withSeparator(char separator)	A fluent setter to setup the separator within a key in the flattened JSON.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

JsonUnflattener

public JsonUnflattener(String json)

Creates a JSON unflattener.

Parameters:

json - the JSON string

JsonUnflattener

public JsonUnflattener(Reader jsonReader)
                throws IOException

Creates a JSON unflattener.

Parameters:

jsonReader - the JSON reader

Throws:

IOException - if jsonReader cannot be read

Method Detail

unflatten

public static String unflatten(String json)

Returns a JSON string of nested objects by the given flattened JSON string.

Parameters:

json - a flattened JSON string

Returns:

a JSON string of nested objects

withFlattenMode

public JsonUnflattener withFlattenMode(FlattenMode flattenMode)

A fluent setter to setup a mode of the JsonUnflattener.

Parameters:

flattenMode - a FlattenMode

Returns:

this JsonUnflattener

withSeparator

public JsonUnflattener withSeparator(char separator)

A fluent setter to setup the separator within a key in the flattened JSON. The default separator is a dot(.).

Parameters:

separator - any character

Returns:

this JsonUnflattener

withLeftAndRightBrackets

public JsonUnflattener withLeftAndRightBrackets(char leftBracket,
                                                char rightBracket)

A fluent setter to setup the left and right brackets within a key in the flattened JSON. The default left and right brackets are left square bracket([) and right square bracket(]).

Parameters:

leftBracket - any character

rightBracket - any character

Returns:

this JsonUnflattener

withPrintMode

public JsonUnflattener withPrintMode(PrintMode printMode)

A fluent setter to setup a print mode of the JsonUnflattener. The default print mode is minimal.

Parameters:

printMode - a PrintMode

Returns:

this JsonUnflattener

withKeyTransformer

public JsonUnflattener withKeyTransformer(KeyTransformer keyTrans)

A fluent setter to setup a KeyTransformer of the JsonUnflattener.

Parameters:

keyTrans - a KeyTransformer

Returns:

this JsonUnflattener

unflatten

public String unflatten()

Returns a JSON string of nested objects by the given flattened JSON string.

Returns:

a JSON string of nested objects

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object