com.googlecode.fascinator.common

Class JsonConfigHelper

java.lang.Object

com.googlecode.fascinator.common.JsonConfigHelper

public class JsonConfigHelper
extends java.lang.Object

Helper class for working with JSON configuration. Uses the JXPath library to use XPath syntax to access JSON nodes.

Author:

Oliver Lucido

Constructor Summary

Constructors

Constructor and Description
JsonConfigHelper() Creates an empty JSON configuration
JsonConfigHelper(java.io.File jsonFile) Creates a JSON configuration from the specified file
JsonConfigHelper(java.io.InputStream jsonIn) Creates a JSON configuration from the specified input stream
JsonConfigHelper(java.util.Map<java.lang.String,java.lang.Object> rootNode) Creates a JSON configuration from a map.
JsonConfigHelper(java.io.Reader jsonReader) Creates a JSON configuration from the specified reader
JsonConfigHelper(java.lang.String jsonContent) Creates a JSON configuration from the specified string

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	get(java.lang.String path) Gets the value of the specified node
java.lang.String	get(java.lang.String path, java.lang.String defaultValue) Gets the value of the specified node, with a specified default if the not was not found
java.util.List<JsonConfigHelper>	getJsonList(java.lang.String path) Get list of JsonConfigHelper of the specified node
java.util.Map<java.lang.String,JsonConfigHelper>	getJsonMap(java.lang.String path) Get the JSON Map of the specified node
java.util.List<java.lang.Object>	getList(java.lang.String path) Gets values of the specified node as a list.
java.util.Map<java.lang.String,java.lang.Object>	getMap(java.lang.String path) Gets a map of the child nodes of the specified node
java.util.Map<java.lang.String,java.lang.Object>	getMapWithChild(java.lang.String path) Gets a map of the child (and the 2nd level children) nodes of the specified node
java.lang.String	getPlainText(java.lang.String path, java.lang.String defaultValue) Get the value of specified node, with a specified default if it's not found
void	move(java.lang.String source, java.lang.String dest) Move node from one path to another path in the JSON
void	moveAfter(java.lang.String path, java.lang.String refPath) Move node to a node after the specified node
void	moveBefore(java.lang.String path, java.lang.String refPath) Move node to a node before the specified node
void	removePath(java.lang.String path) Remove specified path from json
void	set(java.lang.String path, java.lang.String value) Sets the value of the specified node.
void	setJsonList(java.lang.String path, java.util.List<JsonConfigHelper> jsonList) Set Map on the specified path
void	setJsonMap(java.lang.String path, java.util.Map<java.lang.String,JsonConfigHelper> map) Set Map on the specified path
void	setMap(java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> map) Set map with its child
void	setMultiMap(java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> json) Set Multiple nested map on the specified path
void	store(java.io.Writer writer) Serialises the current state of the JSON configuration to the specified writer.
void	store(java.io.Writer writer, boolean pretty) Serialises the current state of the JSON configuration to the specified writer.
java.lang.String	toString() Convert Json to String
java.lang.String	toString(boolean pretty) Convert Json to String

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonConfigHelper

public JsonConfigHelper()

Creates an empty JSON configuration

JsonConfigHelper

public JsonConfigHelper(java.util.Map<java.lang.String,java.lang.Object> rootNode)

Creates a JSON configuration from a map. This is normally used to create an instance for a subNode returned from one of the get methods.

Parameters:

rootNode - a JSON structured map

JsonConfigHelper

public JsonConfigHelper(java.lang.String jsonContent)
                 throws java.io.IOException

Creates a JSON configuration from the specified string

Parameters:

jsonContent - a JSON content string

Throws:

java.io.IOException - if there was an error parsing or reading the content

JsonConfigHelper

public JsonConfigHelper(java.io.File jsonFile)
                 throws java.io.IOException

Creates a JSON configuration from the specified file

Parameters:

jsonFile - a JSON file

Throws:

java.io.IOException - if there was an error parsing or reading the file

JsonConfigHelper

public JsonConfigHelper(java.io.InputStream jsonIn)
                 throws java.io.IOException

Creates a JSON configuration from the specified input stream

Parameters:

jsonIn - a JSON stream

Throws:

java.io.IOException - if there was an error parsing or reading the stream

JsonConfigHelper

public JsonConfigHelper(java.io.Reader jsonReader)
                 throws java.io.IOException

Creates a JSON configuration from the specified reader

Parameters:

jsonReader - a reader for a JSON file

Throws:

java.io.IOException - if there was an error parsing or reading the reader

Method Detail

get

public java.lang.String get(java.lang.String path)

Gets the value of the specified node

Parameters:

path - XPath to node

Returns:

node value or null if not found

get

public java.lang.String get(java.lang.String path,
                   java.lang.String defaultValue)

Gets the value of the specified node, with a specified default if the not was not found

Parameters:

path - XPath to node

defaultValue - value to return if the node was not found

Returns:

node value or defaultValue if not found

getPlainText

public java.lang.String getPlainText(java.lang.String path,
                            java.lang.String defaultValue)

Get the value of specified node, with a specified default if it's not found

Parameters:

path -

defaultValue -

Returns:

node value or default Value if not found WITHOUT string substitution

getList

public java.util.List<java.lang.Object> getList(java.lang.String path)

Gets values of the specified node as a list. Use this method for JSON arrays.

Parameters:

path - XPath to node

Returns:

value list, possibly empty

getMap

public java.util.Map<java.lang.String,java.lang.Object> getMap(java.lang.String path)

Gets a map of the child nodes of the specified node

Parameters:

path - XPath to node

Returns:

node map, possibly empty

getJsonList

public java.util.List<JsonConfigHelper> getJsonList(java.lang.String path)

Get list of JsonConfigHelper of the specified node

Parameters:

path - XPath to node

Returns:

node list, possibly empty

getJsonMap

public java.util.Map<java.lang.String,JsonConfigHelper> getJsonMap(java.lang.String path)

Get the JSON Map of the specified node

Parameters:

path - XPath to node

Returns:

node map, possibly empty

setMap

public void setMap(java.lang.String path,
          java.util.Map<java.lang.String,java.lang.Object> map)

Set map with its child

Parameters:

path - XPath to node

map - node Map

setMultiMap

public void setMultiMap(java.lang.String path,
               java.util.Map<java.lang.String,java.lang.Object> json)

Set Multiple nested map on the specified path

Parameters:

path - XPath to node

json - node Map

setJsonMap

public void setJsonMap(java.lang.String path,
              java.util.Map<java.lang.String,JsonConfigHelper> map)

Set Map on the specified path

Parameters:

path - XPath to node

map - node Map

setJsonList

public void setJsonList(java.lang.String path,
               java.util.List<JsonConfigHelper> jsonList)

Set Map on the specified path

Parameters:

path - XPath to node

map - node Map

getMapWithChild

public java.util.Map<java.lang.String,java.lang.Object> getMapWithChild(java.lang.String path)

Gets a map of the child (and the 2nd level children) nodes of the specified node

Parameters:

path - XPath to node

Returns:

node map, possibly empty

removePath

public void removePath(java.lang.String path)

Remove specified path from json

Parameters:

path - to node

set

public void set(java.lang.String path,
       java.lang.String value)

Sets the value of the specified node. If the node doesn't exist it is created.

Parameters:

path - XPath to node

value - value to set

move

public void move(java.lang.String source,
        java.lang.String dest)

Move node from one path to another path in the JSON

Parameters:

source - XPath to node

dest - XPath to node

moveBefore

public void moveBefore(java.lang.String path,
              java.lang.String refPath)

Move node to a node before the specified node

Parameters:

path - XPath to node

refPath - XPath to node

moveAfter

public void moveAfter(java.lang.String path,
             java.lang.String refPath)

Move node to a node after the specified node

Parameters:

path - XPath to node

refPath - XPath to node

store

public void store(java.io.Writer writer)
           throws java.io.IOException

Serialises the current state of the JSON configuration to the specified writer. By default this doesn't use a pretty printer.

Parameters:

writer - a writer

Throws:

java.io.IOException - if there was an error writing the configuration

store

public void store(java.io.Writer writer,
         boolean pretty)
           throws java.io.IOException

Serialises the current state of the JSON configuration to the specified writer. The output can be set to be pretty printed if required.

Parameters:

writer - a writer

pretty - use pretty printer

Throws:

java.io.IOException - if there was an error writing the configuration

toString

public java.lang.String toString()

Convert Json to String

Overrides:

toString in class java.lang.Object

Returns:

Json configuration in String

toString

public java.lang.String toString(boolean pretty)

Convert Json to String

Parameters:

pretty - state to format the layout of the Json configuration file

Returns:

Json configuration in String