de.mhus.lib.core.config

Class JsonConfig

java.lang.Object

de.mhus.lib.core.MLog

de.mhus.lib.core.lang.MObject

de.mhus.lib.core.IProperties

de.mhus.lib.core.directory.ResourceNode

de.mhus.lib.core.directory.WritableResourceNode

de.mhus.lib.core.config.IConfig

de.mhus.lib.core.config.JsonConfig

All Implemented Interfaces:

ILog, Serializable, Iterable<Map.Entry<String,Object>>

Direct Known Subclasses:

JsonConfigFile

public class JsonConfig
extends IConfig

JsonConfig class.

Version:

$Id: $Id

Author:

mikehummel

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	name

Fields inherited from class de.mhus.lib.core.directory.WritableResourceNode

MOVE_DOWN, MOVE_FIRST, MOVE_LAST, MOVE_UP

Fields inherited from class de.mhus.lib.core.directory.ResourceNode

compiledCache, compiler

Constructor Summary

Constructors

Constructor and Description
JsonConfig() Constructor for JsonConfig.
JsonConfig(org.codehaus.jackson.node.ObjectNode node) Constructor for JsonConfig.
JsonConfig(String json) Constructor for JsonConfig.
JsonConfig(String name2, JsonConfig jsonConfig, org.codehaus.jackson.node.TextNode textNode) Constructor for JsonConfig.
JsonConfig(String name, WritableResourceNode parent, org.codehaus.jackson.node.ObjectNode node) Constructor for JsonConfig.

Method Summary

Modifier and Type	Method and Description
WritableResourceNode	createConfig(String key) Create a new config and append it at the end of the list.
protected int	findPosOf(org.codehaus.jackson.node.ArrayNode array, JsonConfig config) findPosOf.
InputStream	getInputStream(String key) Return the input stream of a content resource.
String	getName() Return a name of this config element could also be null.
org.codehaus.jackson.node.ObjectNode	getNode() Getter for the field node.
WritableResourceNode	getNode(String name) Returns a inner configuration by the name.
String[]	getNodeKeys() Return all possible, existing inner configuration names.
WritableResourceNode[]	getNodes() Return all inner configurations ignoring the name.
WritableResourceNode[]	getNodes(String name) Return all inner configurations by the given name.
WritableResourceNode	getParent() return the parent config if possible.
Object	getProperty(String name) Overwrite this function to provide values in string format.
String[]	getPropertyKeys() Return all existing keys.
URL	getUrl() getUrl.
boolean	isEditable() Overwrite this function and return true if the property set can be edited.
boolean	isProperty(String name) Return true if the property exists.
int	moveConfig(ResourceNode config, int newPos) Move the position of the configuration in the hole set of configurations.
void	removeConfig(ResourceNode config) Remove a config element from the set.
void	removeProperty(String name) Remove the property field in the list of properties.
void	setProperty(String name, Object value) Overwrite this function to allow changes in properties.
void	write(OutputStream os) write.
void	write(Writer os) write.

Methods inherited from class de.mhus.lib.core.config.IConfig

hasContent, isValide

Methods inherited from class de.mhus.lib.core.directory.WritableResourceNode

setString

Methods inherited from class de.mhus.lib.core.directory.ResourceNode

getExtracted, getExtracted, getExtracted, getInputStream, getNodeByPath, keys

Methods inherited from class de.mhus.lib.core.IProperties

getBoolean, getBoolean, getCalendar, getDate, getDouble, getFloat, getInt, getLong, getNumber, getProperty, getString, getString, iterator, setBoolean, setCalendar, setDate, setDouble, setFloat, setInt, setLong, setNumber, toMap

Methods inherited from class de.mhus.lib.core.lang.MObject

base, base, createBase, forkBase, installBase, isBase, leaveBase, toString

Methods inherited from class de.mhus.lib.core.MLog

log

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

name

protected String name

Constructor Detail

JsonConfig

public JsonConfig(String json)
           throws Exception

Constructor for JsonConfig.

Parameters:

json - a String object.

Throws:

Exception - if any.

JsonConfig

public JsonConfig(org.codehaus.jackson.node.ObjectNode node)

Constructor for JsonConfig.

Parameters:

node - a ObjectNode object.

JsonConfig

public JsonConfig(String name,
                  WritableResourceNode parent,
                  org.codehaus.jackson.node.ObjectNode node)

Constructor for JsonConfig.

Parameters:

name - a String object.

parent - a WritableResourceNode object.

node - a ObjectNode object.

JsonConfig

public JsonConfig()
           throws Exception

Constructor for JsonConfig.

Throws:

Exception - if any.

JsonConfig

public JsonConfig(String name2,
                  JsonConfig jsonConfig,
                  org.codehaus.jackson.node.TextNode textNode)
           throws Exception

Constructor for JsonConfig.

Parameters:

name2 - a String object.

jsonConfig - a JsonConfig object.

textNode - a TextNode object.

Throws:

Exception - if any.

Method Detail

getNode

public WritableResourceNode getNode(String name)

Returns a inner configuration by the name. Inner configurations are not unique. If more then one configurations exists it will return the first one. if no configuration exists it returns null.

Specified by:

getNode in class ResourceNode

Parameters:

name - a String object.

Returns:

a ResourceNode object.

getNodes

public WritableResourceNode[] getNodes(String name)

Return all inner configurations by the given name. The order is like in the configuration file. This never returns null.

Specified by:

getNodes in class ResourceNode

Parameters:

name - a String object.

Returns:

an array of ResourceNode objects.

getNodes

public WritableResourceNode[] getNodes()

Return all inner configurations ignoring the name. The order is like in the configuration file. This never returns null.

Specified by:

getNodes in class ResourceNode

Returns:

an array of ResourceNode objects.

getNodeKeys

public String[] getNodeKeys()

Return all possible, existing inner configuration names.

Specified by:

getNodeKeys in class ResourceNode

Returns:

an array of String objects.

getProperty

public Object getProperty(String name)

Overwrite this function to provide values in string format.

Specified by:

getProperty in class IProperties

Parameters:

name - a String object.

Returns:

null if the property not exists or the property value.

getPropertyKeys

public String[] getPropertyKeys()

Return all existing keys. A property key is unique.

Specified by:

getPropertyKeys in class ResourceNode

Returns:

an array of String objects.

isProperty

public boolean isProperty(String name)

Return true if the property exists.

Specified by:

isProperty in class IProperties

Parameters:

name - a String object.

Returns:

a boolean.

removeProperty

public void removeProperty(String name)

Remove the property field in the list of properties.

Specified by:

removeProperty in class IProperties

Parameters:

name - a String object.

setProperty

public void setProperty(String name,
                        Object value)

Overwrite this function to allow changes in properties.

Specified by:

setProperty in class IProperties

Parameters:

name - a String object.

value - a Object object.

getNode

public org.codehaus.jackson.node.ObjectNode getNode()

Getter for the field node.

Returns:

a ObjectNode object.

getName

public String getName()

Return a name of this config element could also be null. The name most time is the name of a sub config.

Specified by:

getName in class ResourceNode

Returns:

a String object.

createConfig

public WritableResourceNode createConfig(String key)
                                  throws MException

Create a new config and append it at the end of the list. After creation the element is already at the end of the list.

Specified by:

createConfig in class WritableResourceNode

Parameters:

key - a String object.

Returns:

a WritableResourceNode object.

Throws:

MException - if editing is not possible

moveConfig

public int moveConfig(ResourceNode config,
                      int newPos)
               throws MException

Move the position of the configuration in the hole set of configurations. If the config is not part of the set it will throw an exception. The first position is 0.

Specified by:

moveConfig in class WritableResourceNode

Parameters:

config - The config object which you want to move

newPos - Absolute new position or one of the move operators MOVE_UP, MOVE_DOWN, MOVE_FIRST, MOVE_LAST

Returns:

The new pos of the config

Throws:

MException - if editing is not possible or the position is out of range

removeConfig

public void removeConfig(ResourceNode config)
                  throws MException

Remove a config element from the set. If the config element is not part of the set it will not throw an error.

Specified by:

removeConfig in class WritableResourceNode

Parameters:

config - The config object which should be removed.

Throws:

MException - if editing is not possible

findPosOf

protected int findPosOf(org.codehaus.jackson.node.ArrayNode array,
                        JsonConfig config)

findPosOf.

Parameters:

array - a ArrayNode object.

config - a JsonConfig object.

Returns:

a int.

isEditable

public boolean isEditable()

Overwrite this function and return true if the property set can be edited.

Specified by:

isEditable in class IProperties

Returns:

a boolean.

getParent

public WritableResourceNode getParent()

return the parent config if possible.

Specified by:

getParent in class ResourceNode

Returns:

a ResourceNode object.

write

public void write(OutputStream os)
           throws IOException

write.

Parameters:

os - a OutputStream object.

Throws:

IOException - if any.

write

public void write(Writer os)
           throws IOException

write.

Parameters:

os - a Writer object.

Throws:

IOException - if any.

getInputStream

public InputStream getInputStream(String key)

Return the input stream of a content resource.

Specified by:

getInputStream in class ResourceNode

Parameters:

key - Name of a rendition or null for the default content

Returns:

a InputStream object.

getUrl

public URL getUrl()

getUrl.

Specified by:

getUrl in class ResourceNode

Returns:

a URL object.