Package de.mhus.lib.core.config

Class XmlConfig

java.lang.Object

de.mhus.lib.core.MLog

de.mhus.lib.core.lang.MObject

de.mhus.lib.core.AbstractProperties

de.mhus.lib.core.directory.ResourceNode<W>

de.mhus.lib.core.directory.WritableResourceNode<IConfig>

de.mhus.lib.core.config.IConfig

de.mhus.lib.core.config.XmlConfig

All Implemented Interfaces:

ILog, IProperties, IReadProperties, MNlsProvider, Nls, Serializable, Iterable<Map.Entry<String,Object>>, Map<String,Object>

Direct Known Subclasses:

XmlConfigFile

public class XmlConfig
extends IConfig

Implements a configuration loaded from xml structures.

Author:

mhu

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	changed
protected Element	element
protected String	name
protected XmlConfig	parent
static String	VALUE	Use this special key to access the tag value (without inner tags).

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	Description
XmlConfig()
XmlConfig(XmlConfig parent, Element elementByPath)
XmlConfig(Element elementByPath)

Method Summary

Modifier and Type	Method	Description
void	clear()
XmlConfig	createConfig(String name)	Create a new config and append it at the end of the list.
boolean	equals(Object obj)
Document	getDocument()
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.
IConfig	getNode(String key)	Returns a inner configuration by the name.
Collection<String>	getNodeKeys()	Return all possible, existing inner configuration names.
Collection<IConfig>	getNodes()	Return all inner configurations ignoring the name.
Collection<IConfig>	getNodes(String key)	Return all inner configurations by the given name.
IConfig	getParent()	return the parent config if possible.
String	getProperty(String key)	Overwrite this function to provide values in string format.
Collection<String>	getPropertyKeys()	Return all existing keys.
URL	getUrl()
Element	getXmlElement()
boolean	isConfigChanged()
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(IConfig config, int newPos)	Move the position of the configuration in the hole set of configurations.
void	readConfig(Reader file)
void	removeConfig(IConfig config)	Remove a config element from the set.
void	removeProperty(String name)	Remove the property field in the list of properties.
void	setProperty(String key, Object val)	Overwrite this function to allow changes in properties.
void	writeConfig(Writer configStream)
void	writeConfig(Writer configStream, boolean intend)

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

getRenditionProperties, getRenditions, hasContent, isValid

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

setString

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

containsValue, dump, entrySet, getExtracted, getExtracted, getExtracted, getInputStream, getNodeByPath, getRenditionProperties, keys, size, values

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

containsKey, get, getBoolean, getBoolean, getCalendar, getDate, getDouble, getFloat, getFormatted, getInt, getLong, getNumber, getString, getString, isEmpty, iterator, keySet, put, putAll, putReadProperties, remove, setBoolean, setCalendar, setDate, setDouble, setFloat, setInt, setLong, setNumber, toMap

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

getNls, nls, toString

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

log

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

VALUE

public static final String VALUE

Use this special key to access the tag value (without inner tags). This is a special value it will not be listed for keys and can not be removed.

See Also:

Constant Field Values

element

protected Element element

changed

protected boolean changed

parent

protected XmlConfig parent

name

protected String name

Constructor Detail

XmlConfig

public XmlConfig()

XmlConfig

public XmlConfig(Element elementByPath)

XmlConfig

public XmlConfig(XmlConfig parent,
                 Element elementByPath)

Method Detail

getDocument

public Document getDocument()

readConfig

public void readConfig(Reader file)
                throws Exception

Throws:

Exception

getNode

public IConfig getNode(String key)

Description copied from class: ResourceNode

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<IConfig>

Returns:

the node with the name

getNodes

public Collection<IConfig> getNodes()

Description copied from class: ResourceNode

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<IConfig>

Returns:

all nodes

getNodes

public Collection<IConfig> getNodes(String key)

Description copied from class: ResourceNode

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<IConfig>

Returns:

all nodes with the name

getNodeKeys

public Collection<String> getNodeKeys()

Description copied from class: ResourceNode

Return all possible, existing inner configuration names.

Specified by:

getNodeKeys in class ResourceNode<IConfig>

Returns:

keys from nodes

getPropertyKeys

public Collection<String> getPropertyKeys()

Description copied from class: ResourceNode

Return all existing keys. A property key is unique.

Specified by:

getPropertyKeys in class ResourceNode<IConfig>

Returns:

all keys

removeProperty

public void removeProperty(String name)

Description copied from class: AbstractProperties

Remove the property field in the list of properties.

Specified by:

removeProperty in interface IProperties

Specified by:

removeProperty in class AbstractProperties

setProperty

public void setProperty(String key,
                        Object val)

Description copied from class: AbstractProperties

Overwrite this function to allow changes in properties.

Specified by:

setProperty in class AbstractProperties

writeConfig

public void writeConfig(Writer configStream)
                 throws Exception

Throws:

Exception

writeConfig

public void writeConfig(Writer configStream,
                        boolean intend)
                 throws Exception

Throws:

Exception

createConfig

public XmlConfig createConfig(String name)

Description copied from class: WritableResourceNode

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<IConfig>

Returns:

new config node

getProperty

public String getProperty(String key)

Description copied from class: AbstractProperties

Overwrite this function to provide values in string format.

Specified by:

getProperty in interface IReadProperties

Specified by:

getProperty in class AbstractProperties

Returns:

null if the property not exists or the property value.

isProperty

public boolean isProperty(String name)

Description copied from class: AbstractProperties

Return true if the property exists.

Specified by:

isProperty in interface IReadProperties

Specified by:

isProperty in class AbstractProperties

Returns:

if exists

isConfigChanged

public boolean isConfigChanged()

getName

public String getName()

Description copied from class: ResourceNode

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<IConfig>

Returns:

node of this node

moveConfig

public int moveConfig(IConfig config,
                      int newPos)
               throws de.mhus.lib.errors.MException

Description copied from class: WritableResourceNode

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<IConfig>

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:

de.mhus.lib.errors.MException - if editing is not possible or the position is out of range

removeConfig

public void removeConfig(IConfig config)
                  throws de.mhus.lib.errors.MException

Description copied from class: WritableResourceNode

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<IConfig>

Parameters:

config - The config object which should be removed.

Throws:

de.mhus.lib.errors.MException - if editing is not possible

isEditable

public boolean isEditable()

Description copied from class: AbstractProperties

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

Specified by:

isEditable in interface IProperties

Specified by:

isEditable in class AbstractProperties

Returns:

if is editable

getParent

public IConfig getParent()

Description copied from class: ResourceNode

return the parent config if possible.

Specified by:

getParent in class ResourceNode<IConfig>

Returns:

parent node

getXmlElement

public Element getXmlElement()

equals

public boolean equals(Object obj)

Specified by:

equals in interface Map<String,Object>

Overrides:

equals in class Object

getInputStream

public InputStream getInputStream(String key)

Description copied from class: ResourceNode

Return the input stream of a content resource.

Specified by:

getInputStream in class ResourceNode<IConfig>

Parameters:

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

Returns:

input stream

getUrl

public URL getUrl()

Specified by:

getUrl in class ResourceNode<IConfig>

clear

public void clear()