org.apache.avalon.framework.container

Class ContainerUtil


public final class ContainerUtil
extends java.lang.Object

Utility class that makes it easier to transfer a component throught it's lifecycle stages.

Version:
CVS $Revision: 1.13 $ $Date: 2003/02/11 15:58:40 $

Author:
Avalon Development Team

Method Summary

static void
compose(Object object, ComponentManager componentManager)
Deprecated. compose() is no longer the preferred method via which components will be supplied with Components.
static void
configure(Object object, Configuration configuration)
Configure specified object if it implements the Configurable interface.
static void
contextualize(Object object, Context context)
Supply specified object with a Context object if it implements the Contextualizable interface.
static void
dispose(Object object)
Dispose specified object if it implements the Disposable interface.
static void
enableLogging(Object object, Logger logger)
Supply specified object with Logger if it implements the LogEnabled interface.
static void
initialize(Object object)
Initialize specified object if it implements the Initializable interface.
static void
parameterize(Object object, Parameters parameters)
Parameterize specified object if it implements the Parameterizable interface.
static void
service(Object object, ServiceManager serviceManager)
Supply specified object with ServiceManager if it implements the Serviceable interface.
static void
shutdown(Object object)
Run specified object through shutdown lifecycle stages (Stop and Dispose).
static void
start(Object object)
Start specified object if it implements the Startable interface.
static void
stop(Object object)
Stop specified object if it implements the Startable interface.

Method Details

compose

public static void compose(Object object,
                           ComponentManager componentManager)
            throws ComponentException

Deprecated. compose() is no longer the preferred method via which components will be supplied with Components. Please Use service() from Composable instead.

Supply specified object with ComponentManager if it implements the Composable interface.

Parameters:
object - the object to compose
componentManager - the ComponentManager object to use for object. May be null in which case the specified object must not implement Composable.

Throws:
ComponentException - if there is a problem composing object


configure

public static void configure(Object object,
                             Configuration configuration)
            throws ConfigurationException
Configure specified object if it implements the Configurable interface.

Parameters:
object - the object to Start
configuration - the configuration object to use during configuration. May be null in which case the specified object must not implement Configurable

Throws:
ConfigurationException - if there is a problem Configuring object, or the object is Configurable but Configuration is null


contextualize

public static void contextualize(Object object,
                                 Context context)
            throws ContextException
Supply specified object with a Context object if it implements the Contextualizable interface.

Parameters:
object - the object to contextualize
context - the context object to use for object. May be null in which case the specified object must not implement Contextualizable.

Throws:
ContextException - if there is a problem contextualizing object


dispose

public static void dispose(Object object)

Parameters:
object - the object to dispose


enableLogging

public static void enableLogging(Object object,
                                 Logger logger)
Supply specified object with Logger if it implements the LogEnabled interface.

Parameters:
object - the object to Start
logger - the logger to enable component with. May be null in which case the specified object must not implement LogEnabled.


initialize

public static void initialize(Object object)
            throws Exception

Parameters:
object - the object to Initialize


parameterize

public static void parameterize(Object object,
                                Parameters parameters)
            throws ParameterException
Parameterize specified object if it implements the Parameterizable interface.

Parameters:
object - the object to Parameterize.
parameters - the parameters object to use during Parameterization. May be null in which case the specified object must not implement Parameterizable.

Throws:
ParameterException - if there is a problem Parameterizing object


service

public static void service(Object object,
                           ServiceManager serviceManager)
            throws ServiceException
Supply specified object with ServiceManager if it implements the Serviceable interface.

Parameters:
object - the object to service
serviceManager - the serviceManager object to use for object. May be null in which case the specified object must not implement Serviceable.

Throws:
ServiceException - if there is a problem servicing object


shutdown

public static void shutdown(Object object)
            throws Exception
Run specified object through shutdown lifecycle stages (Stop and Dispose).

Parameters:
object - the object to shutdown


start

public static void start(Object object)
            throws Exception

Parameters:
object - the object to Start


stop

public static void stop(Object object)
            throws Exception

Parameters:
object - the object to stop


"Copyright B) 2001 Apache Jakarta Project. All Rights Reserved."