com.neeve.config
Interface IConfigEntity

All Superinterfaces:

IConfigContentNode, IConfigNode

All Known Subinterfaces:

IConfigComplexEntity, IConfigSimpleEntity

public interface IConfigEntity
extends IConfigContentNode

Represents an entity in the configuration repository.

An entity node is a node in the configuration tree containing the configuration for a configurable entity. The configuration tree does not have to terminate at an entity node. The entity node can form part of the address of another entity i.e. a sub-entity of the entity.

Threading:

This class is not safe for concurrent access by multiple threads

Method Summary

void	deserialize(String str, boolean markAsDirty) Deserialize an entity from a string
IConfigEntityContainer	getContainer() Get an entity's container.
String	getName() Get an entity's name.
void	serialize(StringBuilder builder) Serialize an entity to a string.

Methods inherited from interface com.neeve.config.IConfigContentNode

clear, isDirty, setDirty

Methods inherited from interface com.neeve.config.IConfigNode

getAddress, getRepository

Method Detail

getName

String getName()

Get an entity's name.

Threading:

This method is safe for concurrent access by multiple threads

The node name is the name of the entity. The name uniquely identifies the entity in its container.

getContainer

IConfigEntityContainer getContainer()

Get an entity's container.

Threading:

This method is safe for concurrent access by multiple threads

This method returns the parent node (the entity container) of an entity.

serialize

void serialize(StringBuilder builder)

Serialize an entity to a string.

Parameters:

builder - The string builder to serialize the entity to.

Threading:

This method is not safe for concurrent access by multiple threads

deserialize

void deserialize(String str,
                 boolean markAsDirty)
                 throws EConfigException

Deserialize an entity from a string

Parameters:

str - The string to derialize from.

markAsDirty - Indicates whether to mark the entity as dirty.

Throws:

EConfigException

Threading:

This method is not safe for concurrent access by multiple threads

This method populates the entity fron content encoded in the supplied string.