de.mhus.lib.core.config

Class HashConfig

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.HashConfig

All Implemented Interfaces:

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

Direct Known Subclasses:

DefComponent

public class HashConfig
extends IConfig

HashConfig class.

Version:

$Id: $Id

Author:

mikehummel

See Also:

Serialized Form

Field Summary

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
HashConfig() Constructor for HashConfig.
HashConfig(Map<String,String> fill) Constructor for HashConfig.
HashConfig(String name, WritableResourceNode parent) Constructor for HashConfig.

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.
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.
ResourceNode	getNode(String key) Returns a inner configuration by the name.
String[]	getNodeKeys() Return all possible, existing inner configuration names.
ResourceNode[]	getNodes() Return all inner configurations ignoring the name.
ResourceNode[]	getNodes(String key) Return all inner configurations by the given name.
ResourceNode	getParent() return the parent config if possible.
String	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.
Set<String>	keys() keys.
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 key) Remove the property field in the list of properties.
ResourceNode	setConfig(String key, HashConfig child) setConfig.
void	setProperty(String key, Object value) Overwrite this function to allow changes in properties.
void	unlink() unlink.

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

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

Constructor Detail

HashConfig

public HashConfig()

Constructor for HashConfig.

HashConfig

public HashConfig(String name,
                  WritableResourceNode parent)

Constructor for HashConfig.

Parameters:

name - a String object.

parent - a WritableResourceNode object.

HashConfig

public HashConfig(Map<String,String> fill)

Constructor for HashConfig.

Parameters:

fill - a Map object.

Method Detail

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.

getNode

public ResourceNode getNode(String key)

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:

key - a String object.

Returns:

a ResourceNode object.

getNodes

public ResourceNode[] getNodes(String key)

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:

key - a String object.

Returns:

an array of ResourceNode objects.

getNodes

public ResourceNode[] 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.

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

unlink

public void unlink()
            throws MException

unlink.

Throws:

MException - if any.

setConfig

public ResourceNode setConfig(String key,
                              HashConfig child)
                       throws MException

setConfig.

Parameters:

key - a String object.

child - a HashConfig object.

Returns:

a ResourceNode object.

Throws:

MException - if any.

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

getProperty

public String 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.

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 key)

Remove the property field in the list of properties.

Specified by:

removeProperty in class IProperties

Parameters:

key - a String object.

setProperty

public void setProperty(String key,
                        Object value)

Overwrite this function to allow changes in properties.

Specified by:

setProperty in class IProperties

Parameters:

key - a String object.

value - a Object object.

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 ResourceNode getParent()

return the parent config if possible.

Specified by:

getParent in class ResourceNode

Returns:

a ResourceNode object.

keys

public Set<String> keys()

keys.

Overrides:

keys in class ResourceNode

Returns:

a Set object.

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.