com.screenscraper.events

Interface EventHandler<T extends AbstractEventData>

All Known Implementing Classes:

AbstractEventHandler, DataManagerEventListener

public interface EventHandler<T extends AbstractEventData>

Interface for an event handler

Version:

1.0

Method Summary

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

Method Detail

getHandlerName

@NotNull
default java.lang.String getHandlerName()

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

Returns:

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

handleEvent

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

Handles the triggered event

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