com.screenscraper.events

Class EventEngine

java.lang.Object

com.screenscraper.events.EventEngine

public class EventEngine
extends java.lang.Object

Simple event engine that stores and fires events. The engine methods are thread-safe

Version:

1.0

Constructor Summary

Constructors

Constructor and Description
EventEngine(ScrapingSession session) Creates the event engine

Method Summary

Modifier and Type	Method and Description
<T extends AbstractEventData> void	addEventCallback(EventFireTime<T> eventTime, EventHandler<T> callback) Add a runnable that will be executed at the given time.
<T extends AbstractEventData> void	addEventCallbackWithPriority(EventFireTime<T> eventTime, EventHandler<T> callback, int priority) Add a runnable that will be executed at the given time and priority.
<T extends AbstractEventData> void	clearCallbacksForTime(EventFireTime<T> eventTime) Clears the callbacks for the specified time
<T extends AbstractEventData> java.lang.Object	fireEvent(EventFireTime<T> eventTime, T data) Fires an event for the given time with the given data
<T extends AbstractEventData> java.lang.Object	fireEvent(EventFireTime<T> eventTime, T data, boolean throwException) Fires an event for the given time with the given data
<T extends AbstractEventData> java.util.List<EventHandler<T>>	getAllEventHandlers(EventFireTime<T> eventTime) Returns a list of all callbacks for a given time, in the order they would be run (immutable)
<T extends AbstractEventData> boolean	removeEventCallback(EventFireTime<T> eventTime, EventHandler<T> callback) Remove a runnable that will be executed at the given time
void	reset() Removes all callbacks from the event engine
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

EventEngine

public EventEngine(@Nullable
                   ScrapingSession session)

Creates the event engine

Parameters:

session - The current scraping session (used for logging)

Method Detail

fireEvent

@Nullable
public <T extends AbstractEventData> java.lang.Object fireEvent(@NotNull
                                                                           EventFireTime<T> eventTime,
                                                                           @NotNull
                                                                           T data)

Fires an event for the given time with the given data

Parameters:

eventTime - The time to fire the event

data - The data about the event

Returns:

An object that corresponds to the event time fired, if applicable. Generally this value is ignored

fireEvent

@Nullable
public <T extends AbstractEventData> java.lang.Object fireEvent(@NotNull
                                                                           EventFireTime<T> eventTime,
                                                                           @NotNull
                                                                           T data,
                                                                           boolean throwException)

Fires an event for the given time with the given data

Parameters:

eventTime - The time to fire the event

data - The data about the event

throwException - True if exceptions should be thrown instead of logged. When thrown, future callbacks don't run

Returns:

An object that corresponds to the event time fired, if applicable. Generally this value is ignored

Since:

7.0.9a

addEventCallback

public <T extends AbstractEventData> void addEventCallback(@NotNull
                                                           EventFireTime<T> eventTime,
                                                           @NotNull
                                                           EventHandler<T> callback)

Add a runnable that will be executed at the given time. The priority it will be added at is 0.

Parameters:

eventTime - The time to execute the callback

callback - The callback to execute

addEventCallbackWithPriority

public <T extends AbstractEventData> void addEventCallbackWithPriority(@NotNull
                                                                       EventFireTime<T> eventTime,
                                                                       @NotNull
                                                                       EventHandler<T> callback,
                                                                       int priority)

Add a runnable that will be executed at the given time and priority. Any events added with a higher priority will be executed before this, and any with a lower priority are executed after. For those on the same priority level, they are executed in the reverse order they were added (the most recently added is run first, the first added will be run last)

Parameters:

eventTime - The time to execute the callback

callback - The callback to execute

priority - The priority for this callback. Lower numbers are higher priority.

removeEventCallback

public <T extends AbstractEventData> boolean removeEventCallback(@NotNull
                                                                 EventFireTime<T> eventTime,
                                                                 @NotNull
                                                                 EventHandler<T> callback)

Remove a runnable that will be executed at the given time

Parameters:

eventTime - The time to execute the callback

callback - The callback to remove

Returns:

True if the event was removed, false otherwise

getAllEventHandlers

@NotNull
public <T extends AbstractEventData> java.util.List<EventHandler<T>> getAllEventHandlers(@NotNull
                                                                                                   EventFireTime<T> eventTime)

Returns a list of all callbacks for a given time, in the order they would be run (immutable)

Parameters:

eventTime - The time to for which to get callbacks

Returns:

An immutable list of callbacks for the specified time, in order they would be run

Since:

7.0.9a

clearCallbacksForTime

public <T extends AbstractEventData> void clearCallbacksForTime(@NotNull
                                                                EventFireTime<T> eventTime)

Clears the callbacks for the specified time

Parameters:

eventTime - The time to clear

reset

public void reset()

Removes all callbacks from the event engine

toString

@NotNull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object