com.neeve.config.impl

Class ConfigEntityContainerBase<T extends IConfigEntity>

java.lang.Object

com.neeve.config.ConfigObject

com.neeve.config.impl.ConfigNodeBase

com.neeve.config.impl.ConfigContentNodeBase

com.neeve.config.impl.ConfigEntityContainerBase<T>

All Implemented Interfaces:

IConfigContentNode, IConfigEntityContainer<T>, IConfigNode

Direct Known Subclasses:

ConfigComplexEntityContainerBase, ConfigSimpleEntityContainerBase

public abstract class ConfigEntityContainerBase<T extends IConfigEntity>
extends ConfigContentNodeBase
implements IConfigEntityContainer<T>

Base implementation of a configuration entity container.

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

Method Summary

Methods

Modifier and Type	Method and Description
IConfigContentNode	clear() Implementation of IConfigContentNode.clear()
T	createEntity(String name) Implementation of IConfigEntityContainer.createEntity(java.lang.String)
void	deserialize(String str, boolean markAsDirty) Implementation of IConfigEntityContainer.deserialize(java.lang.String, boolean)
T	getEntity(String name) Implementation of IConfigEntityContainer.getEntity(java.lang.String)
Iterator<T>	iterator() Implementation of IConfigEntityContainer#createMessageBusBinding
T	removeEntity(String name) Implementation of IConfigEntityContainer.removeEntity(java.lang.String)
void	serialize(StringBuilder builder) Implementation of IConfigEntityContainer.serialize(java.lang.StringBuilder)

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

isDirty, setDirty

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

getAddress, getRepository, toString

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

isDirty, setDirty

Methods inherited from interface com.neeve.config.IConfigNode

getAddress, getRepository

Method Detail

createEntity

public final T createEntity(String name)
                                           throws EConfigException

Implementation of IConfigEntityContainer.createEntity(java.lang.String)

Specified by:

createEntity in interface IConfigEntityContainer<T extends IConfigEntity>

Parameters:

name - The name of the entity to create.

Returns:

Returns the newly created entity

Throws:

EConfigException - Thrown if an entity of the specified name already exists in the container.

getEntity

public final T getEntity(String name)

Implementation of IConfigEntityContainer.getEntity(java.lang.String)

Specified by:

getEntity in interface IConfigEntityContainer<T extends IConfigEntity>

Parameters:

name - The name of the entity to retrieve.

Returns:

Returns the entity or null in case no entity of the supplied name is in the container.

removeEntity

public T removeEntity(String name)

Implementation of IConfigEntityContainer.removeEntity(java.lang.String)

Specified by:

removeEntity in interface IConfigEntityContainer<T extends IConfigEntity>

Parameters:

name - The name of the entity to remove.

Returns:

Returns the entity that was removed or null in case no entity of the supplied name is in the container.

serialize

public final void serialize(StringBuilder builder)

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

Specified by:

serialize in interface IConfigEntityContainer<T extends IConfigEntity>

Parameters:

builder - The string builder to use to serialize the container

deserialize

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

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

Specified by:

deserialize in interface IConfigEntityContainer<T extends IConfigEntity>

Parameters:

str - The string to derialize from.

markAsDirty - Indicates whether to mark the container as dirty.

Throws:

EConfigException

iterator

public final Iterator<T> iterator()

Implementation of IConfigEntityContainer#createMessageBusBinding

Specified by:

iterator in interface IConfigEntityContainer<T extends IConfigEntity>

clear

public final IConfigContentNode clear()

Implementation of IConfigContentNode.clear()

Specified by:

clear in interface IConfigContentNode