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.

Author:
rob.

Method Summary
 void addRuntimeListener(RuntimeListener listener)
          Add a ConfigurationListner.
 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(String name, int index, Object value)
          Set an indexed property on the wrapped object.
 void setMappedProperty(String name, String key, Object value)
          Set a mapped property on the wrapped object.
 void setProperty(String name, Object value)
          Set a property on the wrapped object.
 

Method Detail

addRuntimeListener

void addRuntimeListener(RuntimeListener listener)
Add a ConfigurationListner.

Parameters:
listener -

removeRuntimeListener

void removeRuntimeListener(RuntimeListener listener)
Remove a RuntimeListener.

Parameters:
listener -

getClassIdentifier

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

Returns:

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(String name,
                 Object value)
                 throws ArooaPropertyException
Set a property on the wrapped object.

Parameters:
name -
value -
Throws:
ArooaException
ArooaPropertyException

setMappedProperty

void setMappedProperty(String name,
                       String key,
                       Object value)
                       throws ArooaPropertyException
Set a mapped property on the wrapped object.

Parameters:
name -
key -
value -
Throws:
ArooaException
ArooaPropertyException

setIndexedProperty

void setIndexedProperty(String name,
                        int index,
                        Object value)
                        throws ArooaPropertyException
Set an indexed property on the wrapped object.

Parameters:
name -
index -
value -
Throws:
ArooaException
ArooaPropertyException