Class ContainerUtil
- java.lang.Object
-
- org.apache.avalon.framework.container.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
All Methods Static Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static void
compose(java.lang.Object object, ComponentManager componentManager)
Deprecated.compose() is no longer the preferred method via which components will be supplied with Components.static void
configure(java.lang.Object object, Configuration configuration)
Configure specified object if it implements theConfigurable
interface.static void
contextualize(java.lang.Object object, Context context)
Supply specified object with a Context object if it implements theContextualizable
interface.static void
dispose(java.lang.Object object)
Dispose specified object if it implements theDisposable
interface.static void
enableLogging(java.lang.Object object, Logger logger)
Supply specified object with Logger if it implements theLogEnabled
interface.static void
initialize(java.lang.Object object)
Initialize specified object if it implements theInitializable
interface.static void
parameterize(java.lang.Object object, Parameters parameters)
Parameterize specified object if it implements theParameterizable
interface.static void
service(java.lang.Object object, ServiceManager serviceManager)
Supply specified object with ServiceManager if it implements theServiceable
interface.static void
shutdown(java.lang.Object object)
Run specified object through shutdown lifecycle stages (Stop and Dispose).static void
start(java.lang.Object object)
Start specified object if it implements theStartable
interface.static void
stop(java.lang.Object object)
Stop specified object if it implements theStartable
interface.
-
-
-
Method Detail
-
shutdown
public static void shutdown(java.lang.Object object) throws java.lang.Exception
Run specified object through shutdown lifecycle stages (Stop and Dispose).- Parameters:
object
- the object to shutdown- Throws:
java.lang.Exception
- if there is a problem stoppping object
-
enableLogging
public static void enableLogging(java.lang.Object object, Logger logger)
Supply specified object with Logger if it implements theLogEnabled
interface.- Parameters:
object
- the object to Startlogger
- the logger to enable component with. May be null in which case the specified object must not implement LogEnabled.- Throws:
java.lang.IllegalArgumentException
- if the object is LogEnabled but Logger is null
-
contextualize
public static void contextualize(java.lang.Object object, Context context) throws ContextException
Supply specified object with a Context object if it implements theContextualizable
interface.- Parameters:
object
- the object to contextualizecontext
- 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 objectjava.lang.IllegalArgumentException
- if the object is Contextualizable but context is null
-
service
public static void service(java.lang.Object object, ServiceManager serviceManager) throws ServiceException
Supply specified object with ServiceManager if it implements theServiceable
interface.- Parameters:
object
- the object to serviceserviceManager
- 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 objectjava.lang.IllegalArgumentException
- if the object is Servicable but ServiceManager is null
-
compose
public static void compose(java.lang.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 theComposable
interface.- Parameters:
object
- the object to composecomponentManager
- 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 objectjava.lang.IllegalArgumentException
- if the object is Composable but ComponentManager is null
-
configure
public static void configure(java.lang.Object object, Configuration configuration) throws ConfigurationException
Configure specified object if it implements theConfigurable
interface.- Parameters:
object
- the object to Startconfiguration
- 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 nulljava.lang.IllegalArgumentException
- if the object is Configurable but Configuration is null
-
parameterize
public static void parameterize(java.lang.Object object, Parameters parameters) throws ParameterException
Parameterize specified object if it implements theParameterizable
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 objectjava.lang.IllegalArgumentException
- if the object is Parameterizable but parameters is null
-
initialize
public static void initialize(java.lang.Object object) throws java.lang.Exception
Initialize specified object if it implements theInitializable
interface.- Parameters:
object
- the object to Initialize- Throws:
java.lang.Exception
- if there is a problem Initializing object
-
start
public static void start(java.lang.Object object) throws java.lang.Exception
Start specified object if it implements theStartable
interface.- Parameters:
object
- the object to Start- Throws:
java.lang.Exception
- if there is a problem Starting object
-
stop
public static void stop(java.lang.Object object) throws java.lang.Exception
Stop specified object if it implements theStartable
interface.- Parameters:
object
- the object to stop- Throws:
java.lang.Exception
- if there is a problem stoppping object
-
dispose
public static void dispose(java.lang.Object object)
Dispose specified object if it implements theDisposable
interface.- Parameters:
object
- the object to dispose
-
-