org.whaka.util

Class AbstractInitializable

java.lang.Object

org.whaka.util.AbstractInitializable

All Implemented Interfaces:

Initializable

public abstract class AbstractInitializable
extends java.lang.Object
implements Initializable

Abstract implementation of the Initializable. Provides default implementations for all methods.

See Also:

doInitialize(), assertInitialized()

Constructor Summary

Constructors

Constructor and Description
AbstractInitializable()

Method Summary

Modifier and Type	Method and Description
protected void	assertInitialized()
protected void	doInitialize() This method will be called only when initialize() is called for the first time.
void	initialize() This instance should perform all the required operations that will put it into the working state, so it can properly perform any other functionality.
boolean	isInitialized() Returns true if this instance is already initialized and may perform any functionality.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractInitializable

public AbstractInitializable()

Method Detail

initialize

public final void initialize()

Description copied from interface: Initializable

This instance should perform all the required operations that will put it into the working state, so it can properly perform any other functionality.

Note: if some implementation overrides this method it should also provide proper implementation for the Initializable.isInitialized() method!

Note: This method should not throw any exception for being called for the second (or more) time. If this instance is already initialized - method should exit without performing any actual functionality.

General contract is that if Initializable.isInitialized() returns false - this method may and should be called at least once. If Initializable.isInitialized() returns true - this method may be safely called - but not necessary perform any actual functionality.

Specified by:

initialize in interface Initializable

doInitialize

protected void doInitialize()

This method will be called only when initialize() is called for the first time.

isInitialized

public final boolean isInitialized()

Description copied from interface: Initializable

Returns true if this instance is already initialized and may perform any functionality. If this method return false - Initializable.initialize() should be called.

Specified by:

isInitialized in interface Initializable

assertInitialized

protected final void assertInitialized()
                                throws java.lang.IllegalStateException

Throws:

java.lang.IllegalStateException - if isInitialized() returns false