org.sejda.core.notification.dsl

Interface Notifier

All Known Implementing Classes:

ApplicationEventsNotifier

public interface Notifier

DSL interface to expose notification methods.

Author:

Andrea Vacondio

Method Summary

Methods

Modifier and Type	Method and Description
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

Method Detail

taskFailed

void taskFailed(Exception e)

Notifies about a failed task

Parameters:

e - failure exception

taskCompleted

void taskCompleted(long executionTime)

Notifies about a completed task

Parameters:

executionTime - number of millis for the task to complete

taskStarted

void taskStarted()

Notifies about a started task

progressUndetermined

void progressUndetermined()

Notifies about a task progress which is undetermined

stepsCompleted

OngoingNotification stepsCompleted(int completed)

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

Parameters:

completed - number of steps completed

Returns:

the OngoingNotification to perform the notification

stepsCompleted

OngoingNotification stepsCompleted(BigDecimal completed)

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

Parameters:

completed - number of steps completed

Returns:

the OngoingNotification to perform the notification