org.oddjob.arooa.runtime

Interface RuntimeConfiguration

All Known Subinterfaces:

InstanceRuntimeConfiguration

All Known Implementing Classes:

AbstractRuntimeConfiguration

public interface RuntimeConfiguration

The fundamental unit created during the parsing of a configuration. Generally, a runtime is created for each element of a configuration and form a tree hierarchy.

The runtime handles the lifecycle (initialisation, configuration and destruction) of the wrapped object. Lifecycle instructions cascade to children via RuntimeListeners, and children add there values back in to the parent using the setter methods: setProperty(String, Object), setIndexedProperty(String, int, Object), setMappedProperty(String, String, Object).

The runtime is available to client code via a components ArooaContext.

Author:

rob.

Method Summary

Modifier and Type	Method and Description
void	addRuntimeListener(RuntimeListener listener) Add a RuntimeListener.
void	configure() Configure the object this configuration wraps.
void	destroy() Destroy this RuntimeConfiguration.
ArooaClass	getClassIdentifier() Get the name of the class that this RuntimeConfiguration will be configuring.
void	init() Initialise this RuntimeConfiguration.
void	removeRuntimeListener(RuntimeListener listener) Remove a RuntimeListener.
void	setIndexedProperty(java.lang.String name, int index, java.lang.Object value) Set an indexed property on the wrapped object.
void	setMappedProperty(java.lang.String name, java.lang.String key, java.lang.Object value) Set a mapped property on the wrapped object.
void	setProperty(java.lang.String name, java.lang.Object value) Set a property on the wrapped object.

Method Detail

addRuntimeListener

void addRuntimeListener(RuntimeListener listener)

Add a RuntimeListener.

Parameters:

listener - The listener. Must not be null.

removeRuntimeListener

void removeRuntimeListener(RuntimeListener listener)

Remove a RuntimeListener.

Parameters:

listener - The listener. Must not be null.

getClassIdentifier

ArooaClass getClassIdentifier()

Get the name of the class that this RuntimeConfiguration will be configuring. When this RuntimeConfiguration represents a property name, then this class will be the type of the property, not the parent bean.

Returns:

The class.

init

void init()
   throws ArooaConfigurationException

Initialise this RuntimeConfiguration. This will be called by the parser after all child nodes have been parsed and initialised.

Throws:

ArooaConfigurationException

configure

void configure()
        throws ArooaConfigurationException

Configure the object this configuration wraps.

This will be called at the component level by client code. Child RuntimeConfigurations should listen for and propagate configuration events.

Throws:

ArooaConfigurationException

destroy

void destroy()
      throws ArooaConfigurationException

Destroy this RuntimeConfiguration.

This will be called at the component level by client code. Child RuntimeConfigurations should listen for and propagate destroy events.

Unlike configuration, destroy events should be passed to child components as well.

Throws:

ArooaConfigurationException

setProperty

void setProperty(java.lang.String name,
                 java.lang.Object value)
          throws ArooaPropertyException

Set a property on the wrapped object.

Parameters:

name - The name of the property.

value - The value. May be null.

Throws:

ArooaException - If setting the property failed.

ArooaPropertyException

setMappedProperty

void setMappedProperty(java.lang.String name,
                       java.lang.String key,
                       java.lang.Object value)
                throws ArooaPropertyException

Set a mapped property on the wrapped object.

Parameters:

name - The name of the property.

key - The key.

value - The value.

Throws:

ArooaException - If setting the property failed.

ArooaPropertyException

setIndexedProperty

void setIndexedProperty(java.lang.String name,
                        int index,
                        java.lang.Object value)
                 throws ArooaPropertyException

Set an indexed property on the wrapped object.

Parameters:

name - The name of the property.

index - The 0 based index.

value - The value.

Throws:

ArooaException - If setting the property failed.

ArooaPropertyException