org.oddjob.events

Class EventSourceBase<T>

java.lang.Object

org.oddjob.framework.extend.BaseComponent

org.oddjob.framework.extend.BasePrimary

org.oddjob.events.EventSourceBase<T>

Type Parameters:

T -

All Implemented Interfaces:

ArooaContextAware, ArooaSessionAware, EventSource<T>, PropertyChangeNotifier, Iconic, LogEnabled, Resetable, Stateful

Direct Known Subclasses:

FileWatchEventSource, ForEvents, ListSource, PathWatchEvents, StateExpressionNode, StreamWatcher

public abstract class EventSourceBase<T>
extends BasePrimary
implements EventSource<T>, Resetable

Base class for sources of events.

Constructor Summary

Constructors

Constructor and Description
EventSourceBase() Constructor.

Method Summary

Modifier and Type	Method and Description
protected abstract Restore	doStart(java.util.function.Consumer<? super EventOf<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 sub classes to do something on a soft reset.
protected void	setStateException(java.lang.Throwable e)
boolean	softReset() Perform a soft reset.
Restore	start(java.util.function.Consumer<? super EventOf<T>> consumer) Start listening for events.
protected EventStateHandler	stateHandler() Subclasses must provide a StateHandler.

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

Constructor Detail

EventSourceBase

public EventSourceBase()

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()

start

public final Restore start(java.util.function.Consumer<? super EventOf<T>> consumer)
                    throws java.lang.Exception

Description copied from interface: EventSource

Start listening for events.

Specified by:

start in interface EventSource<T>

Parameters:

consumer - The consumer to receive events on.

Returns:

Something that will stop events being sent and free any resources that were used to send the events.

Throws:

java.lang.Exception - If the listening could not be started.

setStateException

protected void setStateException(java.lang.Throwable e)

doStart

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

Throws:

java.lang.Exception

softReset

public boolean softReset()

Description copied from interface: Resetable

Perform a soft reset.

Specified by:

softReset in interface Resetable

Returns:

true if successful.

hardReset

public boolean hardReset()

Description copied from interface: Resetable

Perform a hard reset.

Specified by:

hardReset in interface Resetable

Returns:

true if successful.

onSoftReset

protected void onSoftReset()

Allow sub classes 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.

fireDestroyedState

protected void fireDestroyedState()

Internal method to fire state.

Specified by:

fireDestroyedState in class BaseComponent