ConfigSafeNode (Jacson API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Jacson

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

de.spieleck.config
Class ConfigSafeNode

java.lang.Object
  de.spieleck.config.ConfigSafeNode

All Implemented Interfaces:: ConfigNode, java.io.Serializable

public class ConfigSafeNode
extends java.lang.Object
implements ConfigNode

An implementation of config node, that does not allow the client to proceed upwards in the configuration tree. XXX This is not well thought out, just thinking in code! This is not at all memory efficient, since the Safe nodes can actually multiply the original tree.

Author:: fsn
See Also:: Serialized Form

Nested Class Summary
`protected static class`	`ConfigSafeNode.SafeIterator` Wrapper class to return only safe ConfigNodes

Constructor Summary
`protected`	`ConfigSafeNode(ConfigNode cn, ConfigNode root)` Wrap a node into a safe one and prescibe a root.

Method Summary
`java.util.Iterator`	`children()` Enumerate my children.
`java.util.Iterator`	`childrenNamed(java.lang.String key)` Enumerate children of me, having a certain name.
`int`	`countChildren()` Count the number of children we have.
`int`	`countChildrenNamed(java.lang.String key)` Count the number of children we have.
`ConfigSafeNode`	`createSafeNode(ConfigNode cn)` Moved to a factory pattern to avoid unnecessary constructions
`static ConfigSafeNode`	`createSafeNode(ConfigNode cn, ConfigNode root)` Moved to a factory pattern to avoid unnecessary constructions
`boolean`	`getBoolean()` Get (expanded) value as a boolean.
`boolean`	`getBoolean(java.lang.String path, boolean deflt)` Get (expanded) value of subnode as boolean, using default if necessary.
`ConfigFileNode`	`getBranchNode()` Find the node responsible for reading this node from file.
`double`	`getDouble()` Get (expanded) value as a double.
`double`	`getDouble(java.lang.String path, double deflt)` Get (expanded) value of subnode as double, using default when necessary.
`boolean`	`getInhBoolean(java.lang.String path, boolean deflt)` Get (expanded) value of subnode as boolean searching parent nodes before using default.
`double`	`getInhDouble(java.lang.String path, double deflt)` Get (expanded) value of subnode as double searching parent nodes before using default.
`int`	`getInhInt(java.lang.String path, int deflt)` Get (expanded) value of subnode as int searching parent nodes before using default.
`java.lang.String`	`getInhString(java.lang.String path, java.lang.String deflt)` Get (expanded) value of subnode as String searching parent nodes before using default.
`int`	`getInt()` Get (expanded) value as an integer.
`int`	`getInt(java.lang.String path, int deflt)` Get (expanded) value of subnode as integer, using default when necessary.
`java.lang.String`	`getName()` Get the name of the node.
`ConfigNode`	`getParent()` Get the node above.
`java.lang.String`	`getPath()` Get the complete path of the node.
`protected ConfigNode`	`getRoot()`
`java.lang.String`	`getSourceDescription()` Get something describing the source location of this node.
`java.lang.String`	`getString()` Get (expanded) value as String.
`java.lang.String`	`getString(java.lang.String path, java.lang.String deflt)` Get (expanded) value of subnode as String, using default when necessary.
`java.lang.String`	`getUnexpanded()` Get (expanded) value as String.
`ConfigNode`	`node(java.lang.String path)` Find sub node matching name.
`ConfigNode`	`nodeInh(java.lang.String path)` Find node or parent sub node matching name.
`void`	`printXML(java.io.PrintWriter os)` Pretty print this node with its whole subtree.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigSafeNode

protected ConfigSafeNode(ConfigNode cn,
                         ConfigNode root)

Wrap a node into a safe one and prescibe a root. The root actually marks the branch below which we want to travel... Note that root should be a parent of cn, otherwise the created node is not really "safe".
Note: This is an internal API, use the factory from external.

Method Detail

createSafeNode

public ConfigSafeNode createSafeNode(ConfigNode cn)

Moved to a factory pattern to avoid unnecessary constructions

createSafeNode

public static ConfigSafeNode createSafeNode(ConfigNode cn,
                                            ConfigNode root)

Moved to a factory pattern to avoid unnecessary constructions