com.googlecode.fascinator.common

Class JsonConfig

java.lang.Object

com.googlecode.fascinator.common.JsonConfig

public class JsonConfig
extends java.lang.Object

Manages JSON configuration. Configuration values are read from a specified JSON and if not found, the system-wide JSON will also be searched.

Author:

Oliver Lucido

Constructor Summary

Constructors

Constructor and Description
JsonConfig() Creates a config with only the system settings
JsonConfig(java.io.File jsonFile) Creates a JSON configuration from the specified file
JsonConfig(java.io.InputStream jsonIn) Creates a JSON configuration from the specified input stream
JsonConfig(java.lang.String jsonString) Create a JSON configuration from the specified input string

Method Summary

Methods

Modifier and Type	Method and Description
static java.io.File	backupSystemFile() Performs a backup on the system-wide configuration file from the default config dir if it exists.
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.Map<java.lang.String,JsonConfigHelper>	getJsonMap(java.lang.String path) Gets 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
static java.io.File	getSystemFile() Gets the system-wide configuration file from the default config dir.
boolean	isConfigured() Tests whether or not the system-config has been properly configured.
boolean	isOutdated() To check if configuration file is outdated
void	set(java.lang.String path, java.lang.String value, boolean system) Sets the value of the specified node.
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()

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonConfig

public JsonConfig()
           throws java.io.IOException

Creates a config with only the system settings

Throws:

java.io.IOException - if these was an error parsing or reading the system JSON file

JsonConfig

public JsonConfig(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

JsonConfig

public JsonConfig(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

JsonConfig

public JsonConfig(java.lang.String jsonString)
           throws java.io.IOException

Create a JSON configuration from the specified input string

Parameters:

jsonString -

Throws:

java.io.IOException

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

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

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

set

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

Sets the value of the specified node. If the node doesn't exist it is created. The value can be set in the system configuration if necessary.

Parameters:

path - XPath to node

value - value to set

system - set the value in the system configuration

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

backupSystemFile

public static java.io.File backupSystemFile()
                                     throws java.io.IOException

Performs a backup on the system-wide configuration file from the default config dir if it exists. Returns a reference to the backed up file.

Returns:

the backed up system JSON file

Throws:

java.io.IOException - if there was an error reading or writing either file

getSystemFile

public static java.io.File getSystemFile()
                                  throws java.io.IOException

Gets the system-wide configuration file from the default config dir. If the file doesn't exist, a default is copied to the config dir.

Returns:

the system JSON file

Throws:

java.io.IOException - if there was an error reading or writing the system configuration file

getJsonMap

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

Gets the JSON Map of the specified node

Parameters:

path - XPath to node

Returns:

node map, possibly empty

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

The full JSON string

isConfigured

public boolean isConfigured()

Tests whether or not the system-config has been properly configured.

Returns:

true if configured, false if still using defaults

isOutdated

public boolean isOutdated()

To check if configuration file is outdated

Returns:

true if outdated, false otherwise