Package de.mhus.lib.core.config

Class DirectoryToConfigWrapper

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

All Implemented Interfaces:

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

public class DirectoryToConfigWrapper
extends IConfig

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.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
DirectoryToConfigWrapper(WritableResourceNode<IConfig> node)

Method Summary

Modifier and Type	Method	Description
void	clear()
IConfig	createConfig(String key)	Create a new config and append it at the end of the list.
boolean	equals(Object obj)
boolean	getBoolean(String name, boolean def)
Calendar	getCalendar(String name)
Date	getDate(String name)
double	getDouble(String name, double def)
String	getExtracted(String key)	Returns a compiled and executed string.
String	getExtracted(String key, String def)
float	getFloat(String name, float def)
InputStream	getInputStream(String key)	Return the input stream of a content resource.
int	getInt(String name, int def)
long	getLong(String name, long def)
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.
Number	getNumber(String name, Number def)
ResourceNode<?>	getParent()	return the parent config if possible.
Object	getProperty(String name)	Overwrite this function to provide values in string format.
Collection<String>	getPropertyKeys()	Return all existing keys.
Collection<String>	getRenditions()	Returns a list of available renditions.
String	getString(String name, String def)
URL	getUrl()
int	hashCode()
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.
Iterator<Map.Entry<String,Object>>	iterator()
Set<String>	keys()
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.
void	removeProperty(String key)	Remove the property field in the list of properties.
void	setBoolean(String name, boolean value)
void	setCalendar(String name, Calendar value)
void	setDate(String name, Date value)
void	setDouble(String name, double value)
void	setFloat(String name, float value)
void	setInt(String name, int value)
void	setLong(String name, long value)
void	setNumber(String name, Number value)
void	setProperty(String key, Object value)	Overwrite this function to allow changes in properties.
void	setString(String name, String value)
String	toString()

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

getRenditionProperties, hasContent, isValid

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

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

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

containsKey, get, getBoolean, getFormatted, getString, isEmpty, keySet, put, putAll, putReadProperties, remove, toMap

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

getNls, nls

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

log

Methods inherited from class java.lang.Object

clone, finalize, getClass, 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, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

DirectoryToConfigWrapper

public DirectoryToConfigWrapper(WritableResourceNode<IConfig> node)

Method Detail

getProperty

public Object getProperty(String name)

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.

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.

Specified by:

createConfig in class WritableResourceNode<IConfig>

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.

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

getString

public String getString(String name,
                        String def)

Specified by:

getString in interface IReadProperties

Overrides:

getString in class AbstractProperties

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

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

getBoolean

public boolean getBoolean(String name,
                          boolean def)

Specified by:

getBoolean in interface IReadProperties

Overrides:

getBoolean in class AbstractProperties

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

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

getInt

public int getInt(String name,
                  int def)

Specified by:

getInt in interface IReadProperties

Overrides:

getInt in class AbstractProperties

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

setString

public void setString(String name,
                      String value)

Specified by:

setString in interface IProperties

Overrides:

setString in class WritableResourceNode<IConfig>

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<String,Object>

Overrides:

hashCode in class Object

getLong

public long getLong(String name,
                    long def)

Specified by:

getLong in interface IReadProperties

Overrides:

getLong in class AbstractProperties

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

getName

public String getName()
               throws de.mhus.lib.errors.MException

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

Throws:

de.mhus.lib.errors.MException

toString

public String toString()

Overrides:

toString in class MObject

getFloat

public float getFloat(String name,
                      float def)

Specified by:

getFloat in interface IReadProperties

Overrides:

getFloat in class AbstractProperties

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

getExtracted

public String getExtracted(String key)

Description copied from class: ResourceNode

Returns a compiled and executed string. The string is compiled with StringCompiler and is cached. Example is "this is the value of another $anothername,default$" or with the prefix "root.": "This is a root attribute $root.name$ User the "../" prefix to go one back ...

Overrides:

getExtracted in class ResourceNode<IConfig>

Returns:

extracted values

See Also:

StringCompiler

getDouble

public double getDouble(String name,
                        double def)

Specified by:

getDouble in interface IReadProperties

Overrides:

getDouble in class AbstractProperties

getCalendar

public Calendar getCalendar(String name)
                     throws de.mhus.lib.errors.MException

Specified by:

getCalendar in interface IReadProperties

Overrides:

getCalendar in class AbstractProperties

Throws:

de.mhus.lib.errors.MException

getExtracted

public String getExtracted(String key,
                           String def)

Overrides:

getExtracted in class ResourceNode<IConfig>

getDate

public Date getDate(String name)

Specified by:

getDate in interface IReadProperties

Overrides:

getDate in class AbstractProperties

getParent

public ResourceNode<?> getParent()

Description copied from class: ResourceNode

return the parent config if possible.

Specified by:

getParent in class ResourceNode<IConfig>

Returns:

parent node

keys

public Set<String> keys()

Specified by:

keys in interface IReadProperties

Overrides:

keys in class ResourceNode<IConfig>

Returns:

the keys

setInt

public void setInt(String name,
                   int value)

Specified by:

setInt in interface IProperties

Overrides:

setInt in class AbstractProperties

setLong

public void setLong(String name,
                    long value)

Specified by:

setLong in interface IProperties

Overrides:

setLong in class AbstractProperties

setDouble

public void setDouble(String name,
                      double value)

Specified by:

setDouble in interface IProperties

Overrides:

setDouble in class AbstractProperties

setFloat

public void setFloat(String name,
                     float value)

Specified by:

setFloat in interface IProperties

Overrides:

setFloat in class AbstractProperties

setBoolean

public void setBoolean(String name,
                       boolean value)

Specified by:

setBoolean in interface IProperties

Overrides:

setBoolean in class AbstractProperties

setCalendar

public void setCalendar(String name,
                        Calendar value)

Specified by:

setCalendar in interface IProperties

Overrides:

setCalendar in class AbstractProperties

equals

public boolean equals(Object obj)

Specified by:

equals in interface Map<String,Object>

Overrides:

equals in class Object

setDate

public void setDate(String name,
                    Date value)

Specified by:

setDate in interface IProperties

Overrides:

setDate in class AbstractProperties

setNumber

public void setNumber(String name,
                      Number value)

Specified by:

setNumber in interface IProperties

Overrides:

setNumber in class AbstractProperties

getNumber

public Number getNumber(String name,
                        Number def)

Specified by:

getNumber in interface IReadProperties

Overrides:

getNumber in class AbstractProperties

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

removeProperty

public void removeProperty(String key)

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

Description copied from class: AbstractProperties

Overwrite this function to allow changes in properties.

Specified by:

setProperty in class AbstractProperties

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

iterator

public Iterator<Map.Entry<String,Object>> iterator()

Specified by:

iterator in interface Iterable<Map.Entry<String,Object>>

Overrides:

iterator in class AbstractProperties

getUrl

public URL getUrl()

Specified by:

getUrl in class ResourceNode<IConfig>

getRenditions

public Collection<String> getRenditions()

Description copied from class: ResourceNode

Returns a list of available renditions. Will not return the default rendition.

Overrides:

getRenditions in class IConfig

Returns:

The list or null if hasContent() is false

clear

public void clear()