Package org.apache.turbine.services
Class BaseInitable
- java.lang.Object
-
- org.apache.turbine.services.BaseInitable
-
- All Implemented Interfaces:
Initable
- Direct Known Subclasses:
BaseService
public class BaseInitable extends Object implements Initable
This class provides a generic implementation ofInitable
. This implementation, that otherInitables
are welcome to extend, contains facilities to maintain internal state.- Version:
- $Id$
- Author:
- Kevin Burton, Rafal Krzewski
-
-
Field Summary
Fields Modifier and Type Field Description protected InitableBroker
initableBroker
InitableBroker that instantiatd this class.protected boolean
isInitialized
Initialization status of this class.
-
Constructor Summary
Constructors Constructor Description BaseInitable()
Default constructor of BaseInitable.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
getInit()
Returns initialization status.InitableBroker
getInitableBroker()
Returns an InitableBroker reference.void
init()
Performs late initialization.void
init(Object data)
Performs early initialization.protected void
setInit(boolean value)
Sets initialization status.void
setInitableBroker(InitableBroker broker)
Saves InitableBroker reference for later use.void
shutdown()
Returns an Initable to uninitialized state.
-
-
-
Field Detail
-
initableBroker
protected InitableBroker initableBroker
InitableBroker that instantiatd this class.
-
isInitialized
protected boolean isInitialized
Initialization status of this class.
-
-
Constructor Detail
-
BaseInitable
public BaseInitable()
Default constructor of BaseInitable. This constructor does nothing. Your own constructurs should be modest in allocating memory and other resources, leaving this to theinit()
method.
-
-
Method Detail
-
setInitableBroker
public void setInitableBroker(InitableBroker broker)
Saves InitableBroker reference for later use.- Specified by:
setInitableBroker
in interfaceInitable
- Parameters:
broker
- The InitableBroker that instantiated this object.
-
getInitableBroker
public InitableBroker getInitableBroker()
Returns an InitableBroker reference.- Returns:
- The InitableBroker that instantiated this object.
-
init
public void init(Object data) throws InitializationException
Performs early initialization. Used in a manner similar to a ctor. BaseInitable doesn't need early initialization, therefore it ignores all objects passed to it and performs no initialization activities.- Specified by:
init
in interfaceInitable
- Parameters:
data
- An Object to use for initialization activities.- Throws:
InitializationException
- Initialization of this class was not successful.
-
init
public void init() throws InitializationException
Performs late initialization. Called when the Service is requested for the first time (if not already completely initialized by the early initializer). Late initialization of a BaseInitable is always successful.- Specified by:
init
in interfaceInitable
- Throws:
InitializationException
- Initialization of this class was not successful.
-
shutdown
public void shutdown()
Returns an Initable to uninitialized state. Calls setInit(false) to mark that we are no longer in initialized state.
-
getInit
public boolean getInit()
Returns initialization status.
-
setInit
protected void setInit(boolean value)
Sets initialization status.- Parameters:
value
- The new initialization status.
-
-