org.sejda.core.notification.dsl

Class ApplicationEventsNotifier

java.lang.Object

org.sejda.core.notification.dsl.ApplicationEventsNotifier

All Implemented Interfaces:

Notifier, OngoingNotification

public final class ApplicationEventsNotifier
extends Object
implements Notifier, OngoingNotification

An DSL class that can be used to notify all the global and local listeners about an event. All the listeners registered on the GlobalNotificationContext and on the ThreadLocalNotificationContext will be notified.

Author:

Andrea Vacondio

See Also:

NotificationContext.notifyListeners(AbstractNotificationEvent)

Method Summary

Methods

Modifier and Type	Method and Description
static Notifier	notifyEvent(NotifiableTaskMetadata taskMetadata) Entry point to create a notification using DSL.
void	outOf(BigDecimal total)
void	outOf(int total)
void	progressUndetermined() Notifies about a task progress which is undetermined
OngoingNotification	stepsCompleted(BigDecimal completed) Notifies about a certain amount of steps completed: notifyEvent().stepsCompleted(new BigDecimal("2").outOf(10);
OngoingNotification	stepsCompleted(int completed) Notifies about a certain amount of steps completed: notifyEvent().stepsCompleted(2).outOf(10);
void	taskCompleted(long executionTime) Notifies about a completed task
void	taskFailed(Exception e) Notifies about a failed task
void	taskStarted() Notifies about a started task

Methods inherited from class java.lang.Object

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

Method Detail

notifyEvent

public static Notifier notifyEvent(NotifiableTaskMetadata taskMetadata)

Entry point to create a notification using DSL.

Examples:
NotifiableTaskMetadata taskMetadata = ... notifyEvent(taskMetadata).stepsCompleted(2).outOf(10);
notifyEvent(taskMetadata).taskCompleted();

Returns:

the notifier

taskFailed

public void taskFailed(Exception e)

Description copied from interface: Notifier

Notifies about a failed task

Specified by:

taskFailed in interface Notifier

Parameters:

e - failure exception

taskCompleted

public void taskCompleted(long executionTime)

Description copied from interface: Notifier

Notifies about a completed task

Specified by:

taskCompleted in interface Notifier

Parameters:

executionTime - number of millis for the task to complete

taskStarted

public void taskStarted()

Description copied from interface: Notifier

Notifies about a started task

Specified by:

taskStarted in interface Notifier

progressUndetermined

public void progressUndetermined()

Description copied from interface: Notifier

Notifies about a task progress which is undetermined

Specified by:

progressUndetermined in interface Notifier

stepsCompleted

public OngoingNotification stepsCompleted(int completed)

Description copied from interface: Notifier

Notifies about a certain amount of steps completed:
notifyEvent().stepsCompleted(2).outOf(10);

Specified by:

stepsCompleted in interface Notifier

Parameters:

completed - number of steps completed

Returns:

the OngoingNotification to perform the notification

stepsCompleted

public OngoingNotification stepsCompleted(BigDecimal completed)

Description copied from interface: Notifier

Notifies about a certain amount of steps completed:
notifyEvent().stepsCompleted(new BigDecimal("2").outOf(10);

Specified by:

stepsCompleted in interface Notifier

Parameters:

completed - number of steps completed

Returns:

the OngoingNotification to perform the notification

outOf

public void outOf(int total)

Specified by:

outOf in interface OngoingNotification

Parameters:

total - the total number of steps

outOf

public void outOf(BigDecimal total)

Specified by:

outOf in interface OngoingNotification

Parameters:

total - the total number of steps