sk.stuba.fiit.perconik.activity.listeners

Class RegularListener<L extends RegularListener<L>>

java.lang.Object

sk.stuba.fiit.perconik.activity.listeners.AbstractListener

sk.stuba.fiit.perconik.activity.listeners.RegularListener<L>

All Implemented Interfaces:

Listener, Registrable, Configurable, ScopedConfigurable

Direct Known Subclasses:

ActivityListener

public abstract class RegularListener<L extends RegularListener<L>>
extends AbstractListener
implements ScopedConfigurable

TODO

Since:

1.0

Author:

Pavol Zbell

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RegularListener.AbstractConfiguration<C,L extends Listener>
protected class	RegularListener.AbstractConfigurationProbe
static class	RegularListener.AbstractDisposalHook<L extends RegularListener<L>>
protected class	RegularListener.AbstractInstanceProbe
static class	RegularListener.AbstractOptionsLoader<L extends RegularListener<L>>
protected class	RegularListener.AbstractOptionsProbe
protected class	RegularListener.AbstractRegistrationProbe
protected class	RegularListener.AbstractStatisticsProbe
static class	RegularListener.BasicDisposalHook<L extends RegularListener<L>>
static interface	RegularListener.Configuration<C,L extends Listener>
protected static class	RegularListener.ContinuousEvent<L extends ActivityListener,E>
static interface	RegularListener.DataInjector<L extends Listener>
static interface	RegularListener.DisposalHook<L extends Listener>
static interface	RegularListener.EventValidator<L extends Listener>
static interface	RegularListener.OptionsLoader<L extends Listener>
static interface	RegularListener.PersistenceStore<L extends Listener>
static class	RegularListener.ProbingDataInjector
static interface	RegularListener.RegisterFailureHandler<L extends Listener>
static class	RegularListener.RegularConfiguration<C,L extends Listener>
protected class	RegularListener.RegularConfigurationProbe
protected class	RegularListener.RegularInstanceProbe
protected class	RegularListener.RegularOptionsProbe
protected class	RegularListener.RegularRegistrationProbe
protected class	RegularListener.RegularStatisticsProbe
static interface	RegularListener.SendFailureHandler<L extends Listener>
static class	RegularListener.StoreWrapper<L extends Listener>
static interface	RegularListener.TimeContext
static class	RegularListener.UpdatingOptionsLoader<L extends RegularListener<L>>

Nested classes/interfaces inherited from class sk.stuba.fiit.perconik.activity.listeners.AbstractListener

AbstractListener.InternalProbe<T>, AbstractListener.RegistrationHook

Field Summary

Fields

Modifier and Type	Field and Description
protected RegularListener.DataInjector<? super L>	dataInjector Underlying event data injector for injecting additional data to event objects before validation.
protected DisplayExecutor	displayExecutor Underlying display executor for executing tasks requiring UI threads.
protected RegularListener.EventValidator<? super L>	eventValidator Underlying event data validator for validating event objects before persistence.
protected RegularListener.OptionsLoader<? super L>	optionsLoader Underlying listener options holder.
protected RegularListener.PersistenceStore<? super L>	persistenceStore Underlying persistence store for persisting event data.
protected PluginConsole	pluginConsole Underlying plug-in console for general logging.
protected RegularListener.SendFailureHandler<? super L>	sendFailureHandler Underlying event data send failure handler.
protected java.util.concurrent.ExecutorService	sharedExecutor Underlying executor service for executing common commands.
protected RegularListener.TimeContext	timeContext Underlying time context.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RegularListener(RegularListener.Configuration<C,L> configuration) Constructor for use by subclasses.
protected	RegularListener(RegularListener.Configuration<C,L> configuration, C context) Constructor for use by subclasses.

Method Summary

Modifier and Type	Method and Description
protected com.google.common.base.Stopwatch	createStopwatch()
protected long	currentTime()
protected Options	customOptions() Returns an updating view of custom options.
protected Options	defaultOptions() Returns an updating view of default options.
protected Options	effectiveOptions() Returns an updating view of effective options.
protected com.google.common.base.Ticker	elapsedTimeTicker()
protected <V> V	execute(DisplayTask<V> task)
protected void	execute(java.lang.Runnable command)
Options	getOptions() Gets effective options of this configurable instance.
Options	getOptions(Scope scope) Gets scoped options of this configurable instance.
protected Options	getOptionsForNonStandardScope(Scope scope)
RegularListener.TimeContext	getTimeContext()
protected void	inject(java.lang.String path, Event data)
protected java.util.Map<java.lang.String,AbstractListener.InternalProbe<?>>	internalProbeMappings()
protected void	onFinalUnregistration() Invoked automatically on final unregistration when workbench is closing.
protected void	onOptionsReload() Invoked always after RegularListener.OptionsLoader loads any options.
protected void	onWorkbenchShutdown() Invoked automatically on workbench shutdown.
protected void	persist(java.lang.String path, Event data)
protected void	postRegisterFailure(java.lang.Runnable task, java.lang.Exception failure)
protected void	postUnregisterFailure(java.lang.Runnable task, java.lang.Exception failure)
protected void	preRegisterFailure(java.lang.Runnable task, java.lang.Exception failure)
protected void	preUnregisterFailure(java.lang.Runnable task, java.lang.Exception failure)
protected void	reloadOptions() An OptionsLoader invokes this method to reload effective options.
protected void	sendFailure(java.lang.String path, Event data, java.lang.Exception failure)
protected void	validate(java.lang.String path, Event data)
protected TimeSource	wallTimeSource()

Methods inherited from class sk.stuba.fiit.perconik.activity.listeners.AbstractListener

clone, equals, finalize, hashCode, postRegister, postUnregister, preRegister, preUnregister, send, send, send, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

optionsLoader

protected final RegularListener.OptionsLoader<? super L extends RegularListener<L>> optionsLoader

Underlying listener options holder.

timeContext

protected final RegularListener.TimeContext timeContext

Underlying time context.

pluginConsole

protected final PluginConsole pluginConsole

Underlying plug-in console for general logging.

displayExecutor

protected final DisplayExecutor displayExecutor

Underlying display executor for executing tasks requiring UI threads.

sharedExecutor

protected final java.util.concurrent.ExecutorService sharedExecutor

Underlying executor service for executing common commands.

dataInjector

protected final RegularListener.DataInjector<? super L extends RegularListener<L>> dataInjector

Underlying event data injector for injecting additional data to event objects before validation.

eventValidator

protected final RegularListener.EventValidator<? super L extends RegularListener<L>> eventValidator

Underlying event data validator for validating event objects before persistence.

persistenceStore

protected final RegularListener.PersistenceStore<? super L extends RegularListener<L>> persistenceStore

Underlying persistence store for persisting event data.

sendFailureHandler

protected final RegularListener.SendFailureHandler<? super L extends RegularListener<L>> sendFailureHandler

Underlying event data send failure handler.

Constructor Detail

RegularListener

protected RegularListener(RegularListener.Configuration<C,L> configuration)

Constructor for use by subclasses.

RegularListener

protected RegularListener(RegularListener.Configuration<C,L> configuration,
                          C context)

Constructor for use by subclasses.

Method Detail

defaultOptions

protected final Options defaultOptions()

Returns an updating view of default options. Updates are dependent on configured RegularListener.OptionsLoader.

Note: always returns the same instance.

customOptions

protected final Options customOptions()

Returns an updating view of custom options. Updates are dependent on configured RegularListener.OptionsLoader.

Note: always returns the same instance.

See Also:

reloadOptions()

effectiveOptions

protected final Options effectiveOptions()

Returns an updating view of effective options. Updates are dependent on configured RegularListener.OptionsLoader.

Note: always returns the same instance.

See Also:

reloadOptions()

reloadOptions

protected final void reloadOptions()

An OptionsLoader invokes this method to reload effective options. Always invokes onOptionsReload() after reloading options.

See Also:

onOptionsReload()

onOptionsReload

protected void onOptionsReload()

Invoked always after RegularListener.OptionsLoader loads any options.

See Also:

reloadOptions()

currentTime

protected final long currentTime()

wallTimeSource

protected final TimeSource wallTimeSource()

createStopwatch

protected final com.google.common.base.Stopwatch createStopwatch()

elapsedTimeTicker

protected final com.google.common.base.Ticker elapsedTimeTicker()

execute

protected final <V> V execute(DisplayTask<V> task)

Specified by:

execute in class AbstractListener

execute

protected final void execute(java.lang.Runnable command)

Specified by:

execute in class AbstractListener

preRegisterFailure

protected final void preRegisterFailure(java.lang.Runnable task,
                                        java.lang.Exception failure)

Specified by:

preRegisterFailure in class AbstractListener

postRegisterFailure

protected final void postRegisterFailure(java.lang.Runnable task,
                                         java.lang.Exception failure)

Specified by:

postRegisterFailure in class AbstractListener

preUnregisterFailure

protected final void preUnregisterFailure(java.lang.Runnable task,
                                          java.lang.Exception failure)

Specified by:

preUnregisterFailure in class AbstractListener

postUnregisterFailure

protected final void postUnregisterFailure(java.lang.Runnable task,
                                           java.lang.Exception failure)

Specified by:

postUnregisterFailure in class AbstractListener

inject

protected final void inject(java.lang.String path,
                            Event data)

Specified by:

inject in class AbstractListener

validate

protected final void validate(java.lang.String path,
                              Event data)

Specified by:

validate in class AbstractListener

persist

protected final void persist(java.lang.String path,
                             Event data)
                      throws java.lang.Exception

Specified by:

persist in class AbstractListener

Throws:

java.lang.Exception

sendFailure

protected final void sendFailure(java.lang.String path,
                                 Event data,
                                 java.lang.Exception failure)

Specified by:

sendFailure in class AbstractListener

internalProbeMappings

protected java.util.Map<java.lang.String,AbstractListener.InternalProbe<?>> internalProbeMappings()

Specified by:

internalProbeMappings in class AbstractListener

onWorkbenchShutdown

protected final void onWorkbenchShutdown()
                                  throws java.lang.Exception

Invoked automatically on workbench shutdown.

Warning: users should not invoke this method directly.

Current implementation does nothing.

Specified by:

onWorkbenchShutdown in class AbstractListener

Throws:

java.lang.Exception

onFinalUnregistration

protected final void onFinalUnregistration()
                                    throws java.lang.Exception

Invoked automatically on final unregistration when workbench is closing.

Warning: users should not invoke this method directly.

Current implementation invokes configured RegularListener.DisposalHook.

Specified by:

onFinalUnregistration in class AbstractListener

Throws:

java.lang.Exception

getOptions

public final Options getOptions()

Gets effective options of this configurable instance.

Note: always returns the same instance.

Specified by:

getOptions in interface Configurable

Returns:

either a snapshot or view of options

getOptions

public final Options getOptions(Scope scope)

Gets scoped options of this configurable instance.

Note: always returns the same instance.

Specified by:

getOptions in interface ScopedConfigurable

Parameters:

scope - the scope to be applied, not null

Returns:

either a snapshot or view of options

Throws:

java.lang.IllegalArgumentException - if an unknown scope is specified

java.lang.NullPointerException - if the scope is null

getOptionsForNonStandardScope

protected Options getOptionsForNonStandardScope(Scope scope)

getTimeContext

public final RegularListener.TimeContext getTimeContext()