Package de.mhus.lib.core.config

Class DirConfig

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

de.mhus.lib.core.config.DirConfig

All Implemented Interfaces:

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

public class DirConfig
extends PropertiesConfig

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 inherited from class de.mhus.lib.core.config.PropertiesConfig

changed, name, properties

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
DirConfig(File dir)

Method Summary

Modifier and Type	Method	Description
IConfig	createConfig(String key)	Create a new config and append it at the end of the list.
File	getDirectory()
String	getName()	Return a name of this config element could also be null.
IConfig	getNode(String key)	Returns a inner configuration by the name.
List<String>	getNodeKeys()	Return all possible, existing inner configuration names.
List<IConfig>	getNodes()	Return all inner configurations ignoring the name.
List<IConfig>	getNodes(String key)	Return all inner configurations by the given name.
IConfig	getParent()	return the parent config if possible.
List<String>	getPropertyKeys()	Return all existing keys.
boolean	isEditable()	Overwrite this function and return true if the property set can be edited.
int	moveConfig(IConfig config, int newPos)	Move the position of the configuration in the hole set of configurations.
void	removeConfig(IConfig config)	Remove a config element from the set.

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

clear, configRemoved, getInputStream, getProperty, getUrl, isConfigChanged, isProperty, readConfig, removeProperty, setProperty, writeConfig

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, equals, 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, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

DirConfig

public DirConfig(File dir)

Method Detail

getPropertyKeys

public List<String> getPropertyKeys()

Description copied from class: ResourceNode

Return all existing keys. A property key is unique.

Overrides:

getPropertyKeys in class PropertiesConfig

Returns:

all keys

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.

Overrides:

getNode in class PropertiesConfig

Returns:

the node with the name

getNodes

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

Overrides:

getNodes in class PropertiesConfig

Returns:

all nodes with the name

getNodes

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

Overrides:

getNodes in class PropertiesConfig

Returns:

all nodes

getNodeKeys

public List<String> getNodeKeys()

Description copied from class: ResourceNode

Return all possible, existing inner configuration names.

Overrides:

getNodeKeys in class PropertiesConfig

Returns:

keys from nodes

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.

Overrides:

getName in class PropertiesConfig

Returns:

node of this node

createConfig

public IConfig createConfig(String key)
                     throws de.mhus.lib.errors.MException

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.

Overrides:

createConfig in class PropertiesConfig

Returns:

new config node

Throws:

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

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.

Overrides:

moveConfig in class PropertiesConfig

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.

Overrides:

removeConfig in class PropertiesConfig

Parameters:

config - The config object which should be removed.

Throws:

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

getParent

public IConfig getParent()

Description copied from class: ResourceNode

return the parent config if possible.

Overrides:

getParent in class PropertiesConfig

Returns:

parent node

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

Overrides:

isEditable in class PropertiesConfig

Returns:

if is editable

getDirectory

public File getDirectory()