com.screenscraper.datamanager

Class DataManagerEventSource

java.lang.Object

com.screenscraper.datamanager.DataManagerEventSource

public class DataManagerEventSource
extends java.lang.Object

Class that passes the events around. The Schema objects contains a reference to this and forwards the methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataManagerEventSource.EventFireTime A set of possible event fire times

Constructor Summary

Constructors

Constructor and Description
DataManagerEventSource() Creates a new event source object

Method Summary

Modifier and Type	Method and Description
boolean	addEventListener(DataManagerEventSource.EventFireTime when, DataManagerEventListener listener) Add a listener.
boolean	addEventListenerWithPriority(DataManagerEventSource.EventFireTime when, DataManagerEventListener listener, int priority) Add a listener with a specified execution priority
void	fireEvent(DataManagerEventSource.EventFireTime when, DataManagerEvent evt) Fire event
java.util.List<DataManagerEventListener>	getEventListeners(DataManagerEventSource.EventFireTime when) retrieve all event listeners
boolean	removeEventListener(DataManagerEventSource.EventFireTime when, DataManagerEventListener listener) remove a listener

Methods inherited from class java.lang.Object

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

Constructor Detail

DataManagerEventSource

public DataManagerEventSource()

Creates a new event source object

Method Detail

addEventListener

public boolean addEventListener(@NotNull
                                DataManagerEventSource.EventFireTime when,
                                @NotNull
                                DataManagerEventListener listener)

Add a listener. Note this uses an incrementing priority, so each event added will run in order they were added. Priority starts at 0 (this means if you add 20 events, the 20th will have a priority of 19). Calls to addEventListenerWithPriority(EventFireTime, DataManagerEventListener, int) do not affect the auto increment counter

Parameters:

when - When the event should be triggered

listener - The listener that will handle the event

Returns:

True if the listener was successfully added, false otherwise

addEventListenerWithPriority

public boolean addEventListenerWithPriority(@NotNull
                                            DataManagerEventSource.EventFireTime when,
                                            @NotNull
                                            DataManagerEventListener listener,
                                            int priority)

Add a listener with a specified execution priority

Parameters:

when - When the event should be triggered

listener - The listener that will handle the event

priority - The priority for the event, with lower numbers being higher priority

Returns:

True if the listener was successfully added, false otherwise

removeEventListener

public boolean removeEventListener(@NotNull
                                   DataManagerEventSource.EventFireTime when,
                                   @NotNull
                                   DataManagerEventListener listener)

remove a listener

Parameters:

when - When the event was triggered

listener - The listener that will be removed

Returns:

True if the listener was successfully removed, false otherwise

getEventListeners

@NotNull
public java.util.List<DataManagerEventListener> getEventListeners(@NotNull
                                                                            DataManagerEventSource.EventFireTime when)

retrieve all event listeners

Parameters:

when - When the events are triggered that should be returned

Returns:

A list of events that are triggered at the given time

fireEvent

public void fireEvent(@NotNull
                      DataManagerEventSource.EventFireTime when,
                      @NotNull
                      DataManagerEvent evt)

Fire event

Parameters:

when - The time to fire the event. This indicates which list of events to use for firing

evt - The event that should be sent to each listener for the given time