org.whaka.util

Class AbstractDestroyable

java.lang.Object

org.whaka.util.AbstractDestroyable

All Implemented Interfaces:

Destroyable

Direct Known Subclasses:

AbstractInitializableAndDestroyable

public abstract class AbstractDestroyable
extends java.lang.Object
implements Destroyable

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

See Also:

doDestroy(), assertNotDestroyed()

Constructor Summary

Constructors

Constructor and Description
AbstractDestroyable()

Method Summary

Modifier and Type	Method and Description
protected void	assertNotDestroyed()
void	destroy() This method may be called to ask instance to release any locked resources and to prepare itself to be properly garbage collected.
protected void	doDestroy() This method will be called only when destroy() is called for the first time.
boolean	isDestroyed() This method returns true if this instance was already destroyed and cannot be used anymore.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractDestroyable

public AbstractDestroyable()

Method Detail

destroy

public final void destroy()

Description copied from interface: Destroyable

This method may be called to ask instance to release any locked resources and to prepare itself to be properly garbage collected.

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

Specified by:

destroy in interface Destroyable

doDestroy

protected void doDestroy()

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

isDestroyed

public final boolean isDestroyed()

Description copied from interface: Destroyable

This method returns true if this instance was already destroyed and cannot be used anymore. If this method returns true - it is a signal for other parts of the program to not perform any additional calls on it.

If this method returns false - Destroyable.destroy() should be called when instance is not planned to be used anymore.

Specified by:

isDestroyed in interface Destroyable

assertNotDestroyed

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

Throws:

java.lang.IllegalStateException