sk.stuba.fiit.perconik.activity.listeners

Class AbstractListener

java.lang.Object

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

All Implemented Interfaces:

Listener, Registrable

Direct Known Subclasses:

RegularListener

public abstract class AbstractListener
extends java.lang.Object
implements Listener

TODO

Since:

1.0

Author:

Pavol Zbell

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractListener.ContinuousEvent<E>
protected class	AbstractListener.InternalProbe<T>
static class	AbstractListener.RegistrationHook

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractListener() Constructor for use by subclasses.

Method Summary

Modifier and Type	Method and Description
protected java.lang.Object	clone() Always throws CloneNotSupportedException.
boolean	equals(java.lang.Object object) Compares the specified object with this listener for equality.
protected abstract <V> V	execute(DisplayTask<V> task)
protected abstract void	execute(java.lang.Runnable command)
protected void	finalize() Listeners should not depend on Java finalization.
int	hashCode()
protected abstract void	inject(java.lang.String path, Event data)
protected abstract java.util.Map<java.lang.String,AbstractListener.InternalProbe<?>>	internalProbeMappings()
protected abstract void	onFinalUnregistration() Invoked automatically on final unregistration when workbench is closing.
protected abstract void	onWorkbenchShutdown() Invoked automatically on workbench shutdown.
protected abstract void	persist(java.lang.String path, Event data)
void	postRegister() Post-register block.
protected abstract void	postRegisterFailure(java.lang.Runnable task, java.lang.Exception failure)
void	postUnregister() Post-unregister block.
protected abstract void	postUnregisterFailure(java.lang.Runnable task, java.lang.Exception failure)
void	preRegister() Pre-register block.
protected abstract void	preRegisterFailure(java.lang.Runnable task, java.lang.Exception failure)
void	preUnregister() Pre-unregister block.
protected abstract void	preUnregisterFailure(java.lang.Runnable task, java.lang.Exception failure)
protected void	send(java.lang.String path, Event data)
protected void	send(java.lang.String path, java.lang.Iterable<Event> batch)
protected void	send(java.lang.String path, java.util.Iterator<Event> batch)
protected abstract void	sendFailure(java.lang.String path, Event data, java.lang.Exception failure)
java.lang.String	toString()
protected abstract void	validate(java.lang.String path, Event data)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractListener

protected AbstractListener()

Constructor for use by subclasses.

Method Detail

execute

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

execute

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

preRegister

public final void preRegister()

Description copied from interface: Registrable

Pre-register block. Called by the registration manager right before it internally registers this object.

Specified by:

preRegister in interface Registrable

preRegisterFailure

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

postRegister

public final void postRegister()

Description copied from interface: Registrable

Post-register block. Called by the registration manager right after it internally registers this object.

Specified by:

postRegister in interface Registrable

postRegisterFailure

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

preUnregister

public final void preUnregister()

Description copied from interface: Registrable

Pre-unregister block. Called by the registration manager right before it internally unregisters this object.

Specified by:

preUnregister in interface Registrable

preUnregisterFailure

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

postUnregister

public final void postUnregister()

Description copied from interface: Registrable

Post-unregister block. Called by the registration manager after before it internally unregisters this object.

Specified by:

postUnregister in interface Registrable

postUnregisterFailure

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

internalProbeMappings

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

inject

protected abstract void inject(java.lang.String path,
                               Event data)
                        throws java.lang.Exception

Throws:

java.lang.Exception

validate

protected abstract void validate(java.lang.String path,
                                 Event data)
                          throws java.lang.Exception

Throws:

java.lang.Exception

persist

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

Throws:

java.lang.Exception

send

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

send

protected final void send(java.lang.String path,
                          java.lang.Iterable<Event> batch)

send

protected final void send(java.lang.String path,
                          java.util.Iterator<Event> batch)

sendFailure

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

equals

public final boolean equals(@Nullable
                            java.lang.Object object)

Description copied from interface: Listener

Compares the specified object with this listener for equality. Returns true if the specified object is also listener and the two listeners have the same implementation classes. This definition ensures that this method works properly across different implementations of the listener interface.

Note: See the documentation of this class for more information regarding listener implementation classes.

Specified by:

equals in interface Listener

Overrides:

equals in class java.lang.Object

Parameters:

object - an object to be compared for equality with this listener

Returns:

true if the specified object is equal to this listener, false otherwise

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

clone

protected final java.lang.Object clone()
                                throws java.lang.CloneNotSupportedException

Always throws CloneNotSupportedException.

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

finalize

protected final void finalize()

Listeners should not depend on Java finalization.

Overrides:

finalize in class java.lang.Object

onWorkbenchShutdown

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

Invoked automatically on workbench shutdown.

Warning: users should not invoke this method directly.

Throws:

java.lang.Exception

onFinalUnregistration

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

Invoked automatically on final unregistration when workbench is closing.

Warning: users should not invoke this method directly.

Throws:

java.lang.Exception

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object