com.sapportals.wcm.util.config
Class ConfigCollection

[contained in: com.sap.netweaver.bc.util.par - bc.util.public_api.jar]

java.lang.Object
  |
  +--com.sapportals.wcm.util.config.ConfigCollection

public class ConfigCollection

extends java.lang.Object

A ConfigCollection is a hirarchical representation of a configuration file. Copyright (c) SAP AG 2001-2002

Constructor Summary

ConfigCollection(java.lang.String name)
Create a new ConfigCollection.

Method Summary

void	addChild(ConfigCollection configCollection) Add a child ConfigCollection.
ConfigCollection	getByPath(java.lang.String path) Get a ConfigCollection by its path in dot-notation.
ConfigCollection	getChild(java.lang.String name) Get a child ConfigCollection by its name.
java.util.Collection	getChildren() Get all children of the ConfigCollection.
java.lang.String	getName() Get the name of the ConfigCollection.
java.lang.String	getProperty(java.lang.String name) Get a property by its name.
java.util.Collection	getPropertyNames() Get all property names in this ConfigCollection.
void	putProperty(java.lang.String name, java.lang.String value) Set/add a property to the ConfigCollection.
void	removeChild(java.lang.String name) Remove a child ConfigCollection.
void	removeProperty(java.lang.String name) Remove a property from the ConfigCollection
void	setByPath(java.lang.String path, ConfigCollection configCollection) Set/Replace a child ConfigCollection by its relative path in dot-notation.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigCollection

public ConfigCollection(java.lang.String name)

Create a new ConfigCollection.

Parameters:

name - the name of the ConfigCollection (the root-node has name = null )

Method Detail

getName

public java.lang.String getName()

Get the name of the ConfigCollection. The root-node has name = null.

Returns:

The name of the ConfigCollection

addChild

public void addChild(ConfigCollection configCollection)

Add a child ConfigCollection.

Parameters:

configCollection - The child to be added

removeChild

public void removeChild(java.lang.String name)

Remove a child ConfigCollection.

Parameters:

name - TBD: Description of the incoming method parameter

getChild

public ConfigCollection getChild(java.lang.String name)

Get a child ConfigCollection by its name.

Parameters:

name - The name of the child

Returns:

The child ConfigCollection or null if none is found

getByPath

public ConfigCollection getByPath(java.lang.String path)

Get a ConfigCollection by its path in dot-notation.

Parameters:

path - The path in dot-notation

Returns:

null if none is found

setByPath

public void setByPath(java.lang.String path,
                      ConfigCollection configCollection)

Set/Replace a child ConfigCollection by its relative path in dot-notation.

Parameters:

path - The path in dot-notation

configCollection - The child ConfigCollection to be set

getChildren

public java.util.Collection getChildren()

Get all children of the ConfigCollection.

Returns:

A Collection of ConfigCollections

putProperty

public void putProperty(java.lang.String name,
                        java.lang.String value)

Set/add a property to the ConfigCollection.

Parameters:

name - The name of the property (dot-notation will be resolved)

value - The value of the property

removeProperty

public void removeProperty(java.lang.String name)

Remove a property from the ConfigCollection

Parameters:

name - The name of the property to by removed (dot-notation will be resoved )

getPropertyNames

public java.util.Collection getPropertyNames()

Get all property names in this ConfigCollection.

Returns:

A Collection of property names

getProperty

public java.lang.String getProperty(java.lang.String name)

Get a property by its name.

Parameters:

name - The name of the property (dot-notation will by resolved)

Returns:

The value of the property or null if none is found