com.neeve.config.impl

Class ConfigComplexEntityBase

java.lang.Object

com.neeve.config.ConfigObject

com.neeve.config.impl.ConfigNodeBase

com.neeve.config.impl.ConfigContentNodeBase

com.neeve.config.impl.ConfigEntityBase

com.neeve.config.impl.ConfigComplexEntityBase

All Implemented Interfaces:

IConfigComplexEntity, IConfigContentNode, IConfigEntity, IConfigNode

Direct Known Subclasses:

MemConfigComplexEntity, PftConfigComplexEntity

public abstract class ConfigComplexEntityBase
extends ConfigEntityBase
implements IConfigComplexEntity

Base implementation of a complex configuration entity.

This class supplies the base implementation for a complex configuration entity. The provider should extend this class and complete the implementation.

Method Summary

Modifier and Type	Method and Description
IConfigContentNode	clear() Implementation of IConfigContentNode.clear()
void	deserialize(String str, boolean markAsDirty) Implementation of IConfigEntity.deserialize(java.lang.String, boolean)
Properties	getProperties(String setname) Implementation of IConfigComplexEntity.getProperties(java.lang.String)
String	getProperty(String setname, String propname, String defval) Implementation of IConfigComplexEntity.getProperty(java.lang.String, java.lang.String, java.lang.String)
Iterator<String>	names() Implementation of IConfigComplexEntity.names()
void	serialize(StringBuilder builder) Implementation of IConfigEntity.serialize(java.lang.StringBuilder)
IConfigComplexEntity	setProperties(String setname, Properties props) Implementation of IConfigComplexEntity.setProperties(java.lang.String, java.util.Properties)
IConfigComplexEntity	setProperty(String setname, String propname, String propval) Implementation of IConfigComplexEntity.setProperty(java.lang.String, java.lang.String, java.lang.String)
String	toString() Returns a string representation of the entity object

Methods inherited from class com.neeve.config.impl.ConfigEntityBase

getContainer, getName

Methods inherited from class com.neeve.config.impl.ConfigContentNodeBase

isDirty, setDirty

Methods inherited from class com.neeve.config.impl.ConfigNodeBase

getAddress, getRepository

Methods inherited from class com.neeve.config.ConfigObject

getTracer

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.neeve.config.IConfigEntity

getContainer, getName

Methods inherited from interface com.neeve.config.IConfigContentNode

isDirty, setDirty

Methods inherited from interface com.neeve.config.IConfigNode

getAddress, getRepository

Method Detail

setProperties

public final IConfigComplexEntity setProperties(String setname,
                                                Properties props)

Implementation of IConfigComplexEntity.setProperties(java.lang.String, java.util.Properties)

Specified by:

setProperties in interface IConfigComplexEntity

Parameters:

setname - The name of the property set in which to set the properties. A property set name must be non-null.

props - The property table from where to set the properties. A value of null will clear the properties for the specified property set.

Returns:

Returns the entity on which the method was invoked for invocation chaining.

getProperties

public final Properties getProperties(String setname)

Implementation of IConfigComplexEntity.getProperties(java.lang.String)

Specified by:

getProperties in interface IConfigComplexEntity

Parameters:

setname - The name of the property set from which to get the properties. A property set name must be non-null.

Returns:

Returns the requested property set.

setProperty

public final IConfigComplexEntity setProperty(String setname,
                                              String propname,
                                              String propval)

Implementation of IConfigComplexEntity.setProperty(java.lang.String, java.lang.String, java.lang.String)

Specified by:

setProperty in interface IConfigComplexEntity

Parameters:

setname - The name of the property set in which to set this value. A property set name must be non-null.

propname - The property name.

propval - The property value.

Returns:

Returns the entoty on which the method was invoked for invocation chaining.

getProperty

public final String getProperty(String setname,
                                String propname,
                                String defval)

Implementation of IConfigComplexEntity.getProperty(java.lang.String, java.lang.String, java.lang.String)

Specified by:

getProperty in interface IConfigComplexEntity

Parameters:

setname - The name of the property set from where to retrieve the property value. A property set name must be non-null.

propname - The name of the property.

defval - The value to return in case the property was not found.

names

public final Iterator<String> names()

Implementation of IConfigComplexEntity.names()

Specified by:

names in interface IConfigComplexEntity

clear

public final IConfigContentNode clear()

Implementation of IConfigContentNode.clear()

Specified by:

clear in interface IConfigContentNode

serialize

public final void serialize(StringBuilder builder)

Implementation of IConfigEntity.serialize(java.lang.StringBuilder)

Specified by:

serialize in interface IConfigEntity

Parameters:

builder - The string builder to serialize the entity to.

deserialize

public final void deserialize(String str,
                              boolean markAsDirty)
                       throws EConfigException

Implementation of IConfigEntity.deserialize(java.lang.String, boolean)

Specified by:

deserialize in interface IConfigEntity

Parameters:

str - The string to derialize from.

markAsDirty - Indicates whether to mark the entity as dirty.

Throws:

EConfigException

toString

public final String toString()

Returns a string representation of the entity object

Overrides:

toString in class ConfigEntityBase