com.screenscraper.datamanager

Class DataManagerEventListener

java.lang.Object

com.screenscraper.datamanager.DataManagerEventListener

All Implemented Interfaces:

EventHandler<DataManagerEvent>

public abstract class DataManagerEventListener
extends java.lang.Object
implements EventHandler<DataManagerEvent>

Interface for users to add their own custom events on certain data operations

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DataManagerEventListener()
protected	DataManagerEventListener(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getHandlerName() Returns a name for the handler to identify it (for debugging purposes)
abstract void	handleEvent(DataManagerEvent event) Handles the event
java.lang.Object	handleEvent(EventFireTime<DataManagerEvent> fireTime, DataManagerEvent data) Handles the triggered event

Methods inherited from class java.lang.Object

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

Constructor Detail

DataManagerEventListener

protected DataManagerEventListener()

DataManagerEventListener

protected DataManagerEventListener(@NotNull
                                   java.lang.String name)

Method Detail

getHandlerName

@NotNull
public java.lang.String getHandlerName()

Description copied from interface: EventHandler

Returns a name for the handler to identify it (for debugging purposes)

Specified by:

getHandlerName in interface EventHandler<DataManagerEvent>

Returns:

A name for the handler to identify it (for debugging purposes)

handleEvent

public abstract void handleEvent(@NotNull
                                 DataManagerEvent event)

Handles the event

Parameters:

event - The event to handle

handleEvent

@Nullable
public java.lang.Object handleEvent(@NotNull
                                               EventFireTime<DataManagerEvent> fireTime,
                                               @NotNull
                                               DataManagerEvent data)

Description copied from interface: EventHandler

Handles the triggered event

Specified by:

handleEvent in interface EventHandler<DataManagerEvent>

Parameters:

fireTime - The object representing the fire time of the event

data - The data associated with the event

Returns:

An object associated with the event. Usually this is ignored. See the event fire time for information on what return values are expected and allowed. The preferred return value is (unless you are returning something specific) data.getLastReturnValue()