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

de.mhus.lib.core.directory.ResourceNode

de.mhus.lib.core.directory.WritableResourceNode

de.mhus.lib.core.config.IConfig

de.mhus.lib.core.config.PropertiesConfig

de.mhus.lib.core.config.DirConfig

All Implemented Interfaces:

IFlatConfig, Iterable<Map.Entry<String,Object>>

public class DirConfig
extends PropertiesConfig

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

Method Summary

Methods

Modifier and Type	Method and Description
WritableResourceNode	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.
WritableResourceNode	getNode(String key) 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 key) Return all inner configurations by the given name.
WritableResourceNode	getParent() return the parent config if possible.
String[]	getPropertyKeys() Return all existing keys.
boolean	isEditable() Overwrite this function and return true if the property set can be edited.
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.

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

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

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

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

Constructor Detail

DirConfig

public DirConfig(File dir)

Method Detail

getPropertyKeys

public String[] getPropertyKeys()

Description copied from class: ResourceNode

Return all existing keys. A property key is unique.

Overrides:

getPropertyKeys in class PropertiesConfig

Returns:

getNode

public WritableResourceNode 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:

getNodes

public WritableResourceNode[] 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:

getNodes

public WritableResourceNode[] 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:

getNodeKeys

public String[] getNodeKeys()

Description copied from class: ResourceNode

Return all possible, existing inner configuration names.

Overrides:

getNodeKeys in class PropertiesConfig

Returns:

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:

createConfig

public WritableResourceNode 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:

Throws:

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

moveConfig

public int moveConfig(ResourceNode 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(ResourceNode 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 WritableResourceNode getParent()

Description copied from class: ResourceNode

return the parent config if possible.

Overrides:

getParent in class PropertiesConfig

Returns:

isEditable

public boolean isEditable()

Description copied from class: IProperties

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

Overrides:

isEditable in class PropertiesConfig

Returns:

getDirectory

public File getDirectory()