org.oddjob.events

Class EventServiceBase<T>

java.lang.Object

org.oddjob.framework.extend.BaseComponent

org.oddjob.framework.extend.BasePrimary

org.oddjob.events.EventServiceBase<T>

Type Parameters:

T - The type of the event.

All Implemented Interfaces:

java.lang.Runnable, ArooaContextAware, ArooaSessionAware, Outbound<T>, PropertyChangeNotifier, Iconic, LogEnabled, Resettable, Stateful, Stoppable

Direct Known Subclasses:

EventWatchComponent, ForEvents, ListSource, StreamWatcher

public abstract class EventServiceBase<T>
extends BasePrimary
implements Outbound<T>, java.lang.Runnable, Resettable, Stateful, Stoppable

Base class for components that want Event Icons because the objects the emmit are in the style of events rather than streams of data.

Constructor Summary

Constructors

Constructor and Description
EventServiceBase() Constructor.

Method Summary

Modifier and Type	Method and Description
protected abstract Restore	doStart(java.util.function.Consumer<? super T> consumer)
protected void	fireDestroyedState() Internal method to fire state.
protected StateChanger<EventState>	getStateChanger()
boolean	hardReset() Perform a hard reset.
protected IconHelper	iconHelper() Subclasses must provide a IconHelper.
protected void	onHardReset() Allow sub classes to do something on a hard reset.
protected void	onReset() Allow sub classes to do something on reset.
protected void	onSoftReset() Allow subclasses to do something on a soft reset.
void	run()
protected void	setStateException(java.lang.Throwable e)
void	setTo(java.util.function.Consumer<? super T> destination) Set the out bound destination.
boolean	softReset() Perform a soft reset.
protected EventStateHandler	stateHandler() Subclasses must provide a StateHandler.
void	stop() Allow subclasses to indicate they are stopping.

Methods inherited from class org.oddjob.framework.extend.BasePrimary

configure, getName, logger, logger, loggerName, save, setName, toString

Methods inherited from class org.oddjob.framework.extend.BaseComponent

addIconListener, addPropertyChangeListener, addStateListener, configure, destroy, firePropertyChange, getArooaSession, iconForId, initialise, lastStateEvent, onConfigured, onDestroy, onInitialised, removeIconListener, removePropertyChangeListener, removeStateListener, save, setArooaContext, setArooaSession

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.oddjob.Stateful

addStateListener, lastStateEvent, removeStateListener

Constructor Detail

EventServiceBase

public EventServiceBase()

Constructor.

Method Detail

stateHandler

protected EventStateHandler stateHandler()

Description copied from class: BaseComponent

Subclasses must provide a StateHandler.

Specified by:

stateHandler in class BaseComponent

Returns:

A State Handler. Never null.

iconHelper

protected IconHelper iconHelper()

Description copied from class: BaseComponent

Subclasses must provide a IconHelper.

Specified by:

iconHelper in class BaseComponent

Returns:

An Icon Helper. Never null.

getStateChanger

protected final StateChanger<EventState> getStateChanger()

run

public void run()

Specified by:

run in interface java.lang.Runnable

setStateException

protected void setStateException(java.lang.Throwable e)

doStart

protected abstract Restore doStart(java.util.function.Consumer<? super T> consumer)
                            throws java.lang.Exception

Throws:

java.lang.Exception

stop

public final void stop()
                throws FailedToStopException

Allow subclasses to indicate they are stopping. The subclass must still implement Stoppable.

Specified by:

stop in interface Stoppable

Throws:

FailedToStopException

softReset

public boolean softReset()

Description copied from interface: Resettable

Perform a soft reset.

Specified by:

softReset in interface Resettable

Returns:

true if successful.

hardReset

public boolean hardReset()

Description copied from interface: Resettable

Perform a hard reset.

Specified by:

hardReset in interface Resettable

Returns:

true if successful.

onSoftReset

protected void onSoftReset()

Allow subclasses to do something on a soft reset. Defaults to onReset()

onHardReset

protected void onHardReset()

Allow sub classes to do something on a hard reset. Defaults to onReset()

onReset

protected void onReset()

Allow sub classes to do something on reset.

setTo

public void setTo(java.util.function.Consumer<? super T> destination)

Description copied from interface: Outbound

Set the out bound destination.

Specified by:

setTo in interface Outbound<T>

fireDestroyedState

protected void fireDestroyedState()

Internal method to fire state.

Specified by:

fireDestroyedState in class BaseComponent