atg.nucleus

Interface SubClasser

All Known Implementing Classes:

SubClasser.MultiSubClasser

public interface SubClasser

Interface for providing a means for Nucleus to dynamically specify a subclass to be created. Can be referred to via the "$instanceFactory" property, to do dynamic AOP-style sub-classing of classes. SubClassers may be chained together, with each SubClasser subclassing the parent class.

Created: March 23 2009

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SubClasser.MultiSubClasser A SubClasser that delegates to multiple SubClasses.
static class	SubClasser.Utilities Utilities for dealing with SubClassers.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Method Summary

Methods

Modifier and Type	Method and Description
void	createdInstance(java.lang.Object pInstance, Nucleus pNucleus, atg.nucleus.PropertyConfiguration pPropertyConfiguration, java.lang.Object pPreviousInstance) Notification after an instance has been created.
java.lang.Class	getSubClass(java.lang.Class pClass, Nucleus pNucleus, atg.nucleus.PropertyConfiguration pPropertyConfiguration, java.lang.Object pPreviousInstance) Get a subclass of the specified class.

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

getSubClass

java.lang.Class getSubClass(java.lang.Class pClass,
                          Nucleus pNucleus,
                          atg.nucleus.PropertyConfiguration pPropertyConfiguration,
                          java.lang.Object pPreviousInstance)
                            throws java.lang.InstantiationException,
                                   java.lang.IllegalAccessException

Get a subclass of the specified class. This method may simply return the original class, or it may return a sub-class instead.

Parameters:

pClass - the class as specified by $class, or perhaps by an earlier subclasser in the chain.

pNucleus - the nucleus instance doing the instantiating

pPropertyConfiguration - the configuration file

pPreviousInstance - the previous instance (only supplied with a reload).

Returns:

the original pClass or a subclass.

Throws:

java.lang.InstantiationException - if an error occurs

java.lang.IllegalAccessException - if an error occurs

createdInstance

void createdInstance(java.lang.Object pInstance,
                   Nucleus pNucleus,
                   atg.nucleus.PropertyConfiguration pPropertyConfiguration,
                   java.lang.Object pPreviousInstance)

Notification after an instance has been created. This allows to the SubClasser to set any needed values on the create instance. Note that the component has not yet been configured by Nucleus at this point, and properties from the PropertyConfiguration will be applied after this method is invoked.

Parameters:

pInstance - the instance that was created.

pNucleus - the nucleus instance doing the instantiating

pPropertyConfiguration - the configuration file

pPreviousInstance - the previous instance (only supplied with a reload).