org.eclipse.osbp.runtime.common.dispose

Class AbstractDisposable

java.lang.Object

org.eclipse.osbp.runtime.common.dispose.AbstractDisposable

All Implemented Interfaces:

IDisposable

Direct Known Subclasses:

DataState, I18nAdapter, SharedStateContext, URLI18nService

public abstract class AbstractDisposable
extends Object
implements IDisposable

Base implementation for IDisposable. Subclasses should override internalDispose() to dispose their content.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.osbp.runtime.common.dispose.IDisposable

IDisposable.DisposableUtil, IDisposable.DisposeException, IDisposable.Listener

Constructor Summary

Constructors

Constructor and Description
AbstractDisposable()

Method Summary

Modifier and Type	Method and Description
void	addDisposeListener(IDisposable.Listener listener) Adds a listener which will be notified if the object was disposed. Adding a listener twice has no effect.
protected boolean	canDispose() Returns true if not disposing and not disposed.
protected void	checkDisposed() Checks whether the element is disposed.
void	dispose() If called, the element will be disposed.
protected List<IDisposable.Listener>	getDisposeListeners() Returns a mutable list of dispose listener.
protected abstract void	internalDispose() Should be overridden by subclasses to dispose their content.
boolean	isDisposed() Returns true, if this object was already disposed.
boolean	isDisposing() Returns true, during the disposal process.
protected void	notifyDisposeListeners() Notifies all listeners about the disposal of that elemenyElement.
void	removeDisposeListener(IDisposable.Listener listener) Remove the dispose listener.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractDisposable

public AbstractDisposable()

Method Detail

isDisposed

public boolean isDisposed()

Returns true, if this object was already disposed.

Specified by:

isDisposed in interface IDisposable

Returns:

disposed

isDisposing

public boolean isDisposing()

Returns true, during the disposal process.

Specified by:

isDisposing in interface IDisposable

Returns:

disposing

dispose

public void dispose()

If called, the element will be disposed. All created ui elements will be removed from its parent and this class will be prepared for garbage collection.
NO further use is possible. Creation of a new element required.

Calling this method twice is allowed.

Specified by:

dispose in interface IDisposable

canDispose

protected boolean canDispose()

Returns true if not disposing and not disposed.

Returns:

true, if successful

internalDispose

protected abstract void internalDispose()

Should be overridden by subclasses to dispose their content.

checkDisposed

protected void checkDisposed()

Checks whether the element is disposed. Throws a DisposeException is the element is disposed.

Throws:

DisposeException - the dispose exception

addDisposeListener

public void addDisposeListener(IDisposable.Listener listener)

Description copied from interface: IDisposable

Adds a listener which will be notified if the object was disposed.
Adding a listener twice has no effect.

Specified by:

addDisposeListener in interface IDisposable

Parameters:

listener - Listener to be added

removeDisposeListener

public void removeDisposeListener(IDisposable.Listener listener)

Description copied from interface: IDisposable

Remove the dispose listener.

Specified by:

removeDisposeListener in interface IDisposable

Parameters:

listener - Listener to be removed

notifyDisposeListeners

protected void notifyDisposeListeners()

Notifies all listeners about the disposal of that elemenyElement.

getDisposeListeners

protected List<IDisposable.Listener> getDisposeListeners()

Returns a mutable list of dispose listener.

Returns:

the disposeListeners