de.mhus.lib.core.directory

Class WritableResourceNode

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

All Implemented Interfaces:

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

Direct Known Subclasses:

IConfig

public abstract class WritableResourceNode
extends ResourceNode

Abstract WritableResourceNode class.

Version:

$Id: $Id

Author:

mikehummel

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	MOVE_DOWN Constant MOVE_DOWN=-101
static int	MOVE_FIRST Constant MOVE_FIRST=-102
static int	MOVE_LAST Constant MOVE_LAST=-103
static int	MOVE_UP Constant MOVE_UP=-100

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

compiledCache, compiler

Constructor Summary

Constructors

Constructor and Description
WritableResourceNode()

Method Summary

Modifier and Type	Method and Description
abstract WritableResourceNode	createConfig(String key) Create a new config and append it at the end of the list.
abstract int	moveConfig(ResourceNode config, int newPos) Move the position of the configuration in the hole set of configurations.
abstract void	removeConfig(ResourceNode config) Remove a config element from the set.
void	setString(String name, String value) setString.

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

getExtracted, getExtracted, getExtracted, getInputStream, getInputStream, getName, getNode, getNodeByPath, getNodeKeys, getNodes, getNodes, getParent, getPropertyKeys, getUrl, hasContent, isValide, keys

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

getBoolean, getBoolean, getCalendar, getDate, getDouble, getFloat, getInt, getLong, getNumber, getProperty, getProperty, getString, getString, isEditable, isProperty, iterator, removeProperty, setBoolean, setCalendar, setDate, setDouble, setFloat, setInt, setLong, setNumber, setProperty, 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

Field Detail

MOVE_UP

public static final int MOVE_UP

Constant MOVE_UP=-100

See Also:

Constant Field Values

MOVE_DOWN

public static final int MOVE_DOWN

Constant MOVE_DOWN=-101

See Also:

Constant Field Values

MOVE_FIRST

public static final int MOVE_FIRST

Constant MOVE_FIRST=-102

See Also:

Constant Field Values

MOVE_LAST

public static final int MOVE_LAST

Constant MOVE_LAST=-103

See Also:

Constant Field Values

Constructor Detail

WritableResourceNode

public WritableResourceNode()

Method Detail

createConfig

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

Parameters:

key - a String object.

Returns:

a WritableResourceNode object.

Throws:

MException - if editing is not possible

moveConfig

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

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

Parameters:

config - The config object which should be removed.

Throws:

MException - if editing is not possible

setString

public void setString(String name,
                      String value)

setString.

Overrides:

setString in class IProperties

Parameters:

name - a String object.

value - a String object.