com.screenscraper.events

Class AbstractEventHandler<T extends AbstractEventData>

java.lang.Object

com.screenscraper.events.AbstractEventHandler<T>

All Implemented Interfaces:

EventHandler<T>

@InternalOnly
public abstract class AbstractEventHandler<T extends AbstractEventData>
extends java.lang.Object
implements EventHandler<T>

Implementation of an EventHandler that handles returning the standard return value automatically

Version:

1.0

Constructor Summary

Constructors

Constructor and Description
AbstractEventHandler()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	handleEvent(EventFireTime<T> fireTime, T data) Handles the triggered event
abstract void	handleEvent(T data) Simplifies the callback by handling the return value automatically.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.screenscraper.events.EventHandler

getHandlerName

Constructor Detail

AbstractEventHandler

public AbstractEventHandler()

Method Detail

handleEvent

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

Description copied from interface: EventHandler

Handles the triggered event

Specified by:

handleEvent in interface EventHandler<T extends AbstractEventData>

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

handleEvent

public abstract void handleEvent(@NotNull
                                 T data)

Simplifies the callback by handling the return value automatically.

Parameters:

data - The event data

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object