org.sejda.core.notification.context

Interface NotificationContext

All Known Implementing Classes:

GlobalNotificationContext

public interface NotificationContext

Interface providing notification configuration. EventListener can be registered to be notified.

Author:

Andrea Vacondio

Method Summary

Methods

Modifier and Type	Method and Description
<T extends AbstractNotificationEvent> void	addListener(Class<T> eventClass, EventListener<T> listener) Adds the input listeners to the context to listen on the input event class.
<T extends AbstractNotificationEvent> void	addListener(EventListener<T> listener) Adds the input listeners to the context.
void	clearListeners() Clears the list of listeners for this context
void	notifyListeners(AbstractNotificationEvent event) Notifies the listeners about the input event
<T extends AbstractNotificationEvent> boolean	removeListener(EventListener<T> listener) Remove the input listener from the context .
int	size()

Method Detail

addListener

<T extends AbstractNotificationEvent> void addListener(EventListener<T> listener)

Adds the input listeners to the context.

Type Parameters:

T - type of the event

Parameters:

listener -

Throws:

NotificationContextException - if unable to infer the listened AbstractNotificationEvent subclass

addListener

<T extends AbstractNotificationEvent> void addListener(Class<T> eventClass,
                                                     EventListener<T> listener)

Adds the input listeners to the context to listen on the input event class.

Type Parameters:

T - type of the event

Parameters:

eventClass -

listener -

removeListener

<T extends AbstractNotificationEvent> boolean removeListener(EventListener<T> listener)

Remove the input listener from the context .

Parameters:

listener -

Returns:

true if the listener was found and removed, false otherwise

Throws:

NotificationContextException - if unable to infer the listened AbstractNotificationEvent subclass

clearListeners

void clearListeners()

Clears the list of listeners for this context

notifyListeners

void notifyListeners(AbstractNotificationEvent event)

Notifies the listeners about the input event

Parameters:

event -

size

int size()

Returns:

the number of the registered listeners