Package ch.tocco.nice2.tasks.impl.progress

Class ProgressImpl

java.lang.Object

ch.tocco.nice2.tasks.impl.progress.ProgressImpl

All Implemented Interfaces:

Progress

public class ProgressImpl
extends Object
implements Progress

Constructor Summary

Constructors

Constructor	Description
ProgressImpl(org.slf4j.Logger log, ProgressBean progressBean, ProgressPersistenceManager progressManager)

Method Summary

Modifier and Type	Method	Description
void	addProgressListener(ProgressListener progressListener)
String	getLabelKey()	Get the textresources key of the progress.
List<ProgressListener>	getProgressListeners()
String	getTaskId()	Get the id of the task.
ProgressBean.Type	getType()	Get the ProgressBean.Type of the progress.
@Nullable Map<String,String>	getVars()	Get the variables (parameters for the placeholders in the label).
void	removeProgressListener(ProgressListener progressListener)
void	updateAbsolute(String labelKey, int total, int done)	Set the ProgressBean.Type of the progress to ProgressBean.Type.RUNNING_ABSOLUTE and display the given label.
void	updateAbsolute(String labelKey, int total, int done, Map<String,String> vars)	Set the ProgressBean.Type of the progress to ProgressBean.Type.RUNNING_ABSOLUTE and display the given label.
void	updateCancelled()	Set the ProgressBean.Type of the progress to ProgressBean.Type.CANCELLED and display the default label (ProgressBean.DEFAULT_CANCELLED) and notification (ProgressBean.DEFAULT_CANCELLED_NOTIFICATION).
void	updateCancelled(String labelKey)	Set the ProgressBean.Type of the progress to ProgressBean.Type.CANCELLED, display the given label and display the default notification (ProgressBean.DEFAULT_CANCELLED_NOTIFICATION).
void	updateCancelled(String labelKey, String notificationKey)	Set the ProgressBean.Type of the progress to ProgressBean.Type.CANCELLED and display the given label and notification.
void	updateCancelled(String labelKey, String notificationKey, Map<String,String> vars)	Set the ProgressBean.Type of the progress to ProgressBean.Type.CANCELLED and display the given label and notification.
void	updateCancelled(String labelKey, Map<String,String> vars)	Set the ProgressBean.Type of the progress to ProgressBean.Type.CANCELLED, display the given label and display the default notification (ProgressBean.DEFAULT_CANCELLED_NOTIFICATION).
void	updateCompleted()	Set the ProgressBean.Type of the progress to ProgressBean.Type.COMPLETED and display the default label (ProgressBean.DEFAULT_COMPLETED) and notification (ProgressBean.DEFAULT_COMPLETED_NOTIFICATION).
void	updateCompleted(String labelKey)	Set the ProgressBean.Type of the progress to ProgressBean.Type.COMPLETED, display the given label and display the default notification (ProgressBean.DEFAULT_COMPLETED_NOTIFICATION).
void	updateCompleted(String labelKey, String notificationKey)	Set the ProgressBean.Type of the progress to ProgressBean.Type.COMPLETED and display the given label and notification.
void	updateCompleted(String labelKey, String notificationKey, ProgressBean.NotificationType notificationType)	Set the ProgressBean.Type of the progress to ProgressBean.Type.COMPLETED and display the given label and notification.
void	updateCompleted(String labelKey, String notificationKey, ProgressBean.NotificationType notificationType, Map<String,String> vars)	Set the ProgressBean.Type of the progress to ProgressBean.Type.COMPLETED and display the given label and notification.
void	updateCompleted(String labelKey, String notificationKey, Map<String,String> vars)	Set the ProgressBean.Type of the progress to ProgressBean.Type.COMPLETED and display the given label and notification.
void	updateCompleted(String labelKey, Map<String,String> vars)	Set the ProgressBean.Type of the progress to ProgressBean.Type.COMPLETED, display the given label and display the default notification (ProgressBean.DEFAULT_COMPLETED_NOTIFICATION).
void	updateFailed()	Set the ProgressBean.Type of the progress to ProgressBean.Type.FAILED and display the default label (ProgressBean.DEFAULT_FAILED) and notification (ProgressBean.DEFAULT_FAILED_NOTIFICATION).
void	updateFailed(String labelKey)	Set the ProgressBean.Type of the progress to ProgressBean.Type.FAILED, display the given label and display the default notification (ProgressBean.DEFAULT_FAILED_NOTIFICATION).
void	updateFailed(String labelKey, String notificationKey)	Set the ProgressBean.Type of the progress to ProgressBean.Type.FAILED and display the given label and notification.
void	updateFailed(String labelKey, String notificationKey, Map<String,String> vars)	Set the ProgressBean.Type of the progress to ProgressBean.Type.FAILED and display the given label and notification.
void	updateFailed(String labelKey, Map<String,String> vars)	Set the ProgressBean.Type of the progress to ProgressBean.Type.FAILED, display the given label and display the default notification (ProgressBean.DEFAULT_FAILED_NOTIFICATION).
void	updateInfinite(String labelKey)	Set the ProgressBean.Type of the progress to ProgressBean.Type.RUNNING_INFINITE and display the given label.
void	updateInfinite(String labelKey, Map<String,String> vars)	Set the ProgressBean.Type of the progress to ProgressBean.Type.RUNNING_INFINITE and display the given label.

Methods inherited from class java.lang.Object

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

Constructor Details

ProgressImpl

public ProgressImpl(org.slf4j.Logger log,
 ProgressBean progressBean,
 ProgressPersistenceManager progressManager)

Method Details

addProgressListener

public void addProgressListener(ProgressListener progressListener)

Specified by:

addProgressListener in interface Progress

removeProgressListener

public void removeProgressListener(ProgressListener progressListener)

Specified by:

removeProgressListener in interface Progress

getProgressListeners

public List<ProgressListener> getProgressListeners()

Specified by:

getProgressListeners in interface Progress

updateInfinite

public void updateInfinite(String labelKey)

Description copied from interface: Progress

Set the ProgressBean.Type of the progress to ProgressBean.Type.RUNNING_INFINITE and display the given label.

Specified by:

updateInfinite in interface Progress

Parameters:

labelKey - the key (text resources) of the label to display

updateInfinite

public void updateInfinite(String labelKey,
 Map<String,String> vars)

Description copied from interface: Progress

Set the ProgressBean.Type of the progress to ProgressBean.Type.RUNNING_INFINITE and display the given label.

Specified by:

updateInfinite in interface Progress

Parameters:

labelKey - the key (text resources) of the label to display

vars - a map with the parameters to replace the placeholders in the label with

updateAbsolute

public void updateAbsolute(String labelKey,
 int total,
 int done)

Description copied from interface: Progress

Set the ProgressBean.Type of the progress to ProgressBean.Type.RUNNING_ABSOLUTE and display the given label.

Specified by:

updateAbsolute in interface Progress

Parameters:

labelKey - the key (text resources) of the label to display

total - the total count of the items

done - the count of the items that are already done

updateAbsolute

public void updateAbsolute(String labelKey,
 int total,
 int done,
 Map<String,String> vars)

Description copied from interface: Progress

Set the ProgressBean.Type of the progress to ProgressBean.Type.RUNNING_ABSOLUTE and display the given label.

Specified by:

updateAbsolute in interface Progress

Parameters:

labelKey - the key (text ressurces) of the label to display

total - the total count of the items

done - the count of the items that are already done

vars - a map with the parameters to replace the placeholders in the label with

updateCompleted

public void updateCompleted()

Description copied from interface: Progress

Set the ProgressBean.Type of the progress to ProgressBean.Type.COMPLETED and display the default label (ProgressBean.DEFAULT_COMPLETED) and notification (ProgressBean.DEFAULT_COMPLETED_NOTIFICATION).

Specified by:

updateCompleted in interface Progress

updateCompleted

public void updateCompleted(String labelKey)

Description copied from interface: Progress

Set the ProgressBean.Type of the progress to ProgressBean.Type.COMPLETED, display the given label and display the default notification (ProgressBean.DEFAULT_COMPLETED_NOTIFICATION).

Specified by:

updateCompleted in interface Progress

Parameters:

labelKey - the key (text resources) of the label to display

updateCompleted

public void updateCompleted(String labelKey,
 Map<String,String> vars)

Description copied from interface: Progress

Set the ProgressBean.Type of the progress to ProgressBean.Type.COMPLETED, display the given label and display the default notification (ProgressBean.DEFAULT_COMPLETED_NOTIFICATION).

Specified by:

updateCompleted in interface Progress

Parameters:

labelKey - the key (text resources) of the label to display

vars - a map with the parameters to replace the placeholders in the label with.

updateCompleted

public void updateCompleted(String labelKey,
 String notificationKey)

Description copied from interface: Progress

Set the ProgressBean.Type of the progress to ProgressBean.Type.COMPLETED and display the given label and notification.

Specified by:

updateCompleted in interface Progress

Parameters:

labelKey - the key (text resources) of the label to display

notificationKey - the key (text resources) of the notification to display

updateCompleted

public void updateCompleted(String labelKey,
 String notificationKey,
 Map<String,String> vars)

Description copied from interface: Progress

Set the ProgressBean.Type of the progress to ProgressBean.Type.COMPLETED and display the given label and notification.

Specified by:

updateCompleted in interface Progress

Parameters:

labelKey - the key (text resources) of the label to display

notificationKey - the key (text resources) of the notification to display

vars - a map with the parameters to replace the placeholders in the label and also in the notification with.

updateCompleted

public void updateCompleted(String labelKey,
 String notificationKey,
 ProgressBean.NotificationType notificationType)

Description copied from interface: Progress

Set the ProgressBean.Type of the progress to ProgressBean.Type.COMPLETED and display the given label and notification.

Specified by:

updateCompleted in interface Progress

Parameters:

labelKey - the key (text resources) of the label to display

notificationKey - the key (text resources) of the notification to display

notificationType - the type of the notification to display

updateCompleted

public void updateCompleted(String labelKey,
 String notificationKey,
 ProgressBean.NotificationType notificationType,
 Map<String,String> vars)

Description copied from interface: Progress

Set the ProgressBean.Type of the progress to ProgressBean.Type.COMPLETED and display the given label and notification.

Specified by:

updateCompleted in interface Progress

Parameters:

labelKey - the key (text resources) of the label to display

notificationKey - the key (text resources) of the notification to display

notificationType - the type of the notification to display

vars - a map with the parameters to replace the placeholders in the label and also in the notification with.

updateFailed

public void updateFailed()

Description copied from interface: Progress

Set the ProgressBean.Type of the progress to ProgressBean.Type.FAILED and display the default label (ProgressBean.DEFAULT_FAILED) and notification (ProgressBean.DEFAULT_FAILED_NOTIFICATION).

Specified by:

updateFailed in interface Progress

updateFailed

public void updateFailed(String labelKey)

Description copied from interface: Progress

Set the ProgressBean.Type of the progress to ProgressBean.Type.FAILED, display the given label and display the default notification (ProgressBean.DEFAULT_FAILED_NOTIFICATION).

Specified by:

updateFailed in interface Progress

Parameters:

labelKey - the key (text resources) of the label to display

updateFailed

public void updateFailed(String labelKey,
 Map<String,String> vars)

Description copied from interface: Progress

Set the ProgressBean.Type of the progress to ProgressBean.Type.FAILED, display the given label and display the default notification (ProgressBean.DEFAULT_FAILED_NOTIFICATION).

Specified by:

updateFailed in interface Progress

Parameters:

labelKey - the key (text resources) of the label to display

vars - a map with the parameters to replace the placeholders in the label with.

updateFailed

public void updateFailed(String labelKey,
 String notificationKey)

Description copied from interface: Progress

Set the ProgressBean.Type of the progress to ProgressBean.Type.FAILED and display the given label and notification.

Specified by:

updateFailed in interface Progress

Parameters:

labelKey - the key (text resources) of the label to display

notificationKey - the key (text resources) of the notification to display

updateFailed

public void updateFailed(String labelKey,
 String notificationKey,
 Map<String,String> vars)

Description copied from interface: Progress

Set the ProgressBean.Type of the progress to ProgressBean.Type.FAILED and display the given label and notification.

Specified by:

updateFailed in interface Progress

Parameters:

labelKey - the key (text resources) of the label to display

notificationKey - the key (text resources) of the notification to display

vars - a map with the parameters to replace the placeholders in the label and also in the notification with.

updateCancelled

public void updateCancelled()

Description copied from interface: Progress

Set the ProgressBean.Type of the progress to ProgressBean.Type.CANCELLED and display the default label (ProgressBean.DEFAULT_CANCELLED) and notification (ProgressBean.DEFAULT_CANCELLED_NOTIFICATION).

Specified by:

updateCancelled in interface Progress

updateCancelled

public void updateCancelled(String labelKey)

Description copied from interface: Progress

Set the ProgressBean.Type of the progress to ProgressBean.Type.CANCELLED, display the given label and display the default notification (ProgressBean.DEFAULT_CANCELLED_NOTIFICATION).

Specified by:

updateCancelled in interface Progress

Parameters:

labelKey - the key (text resources) of the label to display

updateCancelled

public void updateCancelled(String labelKey,
 Map<String,String> vars)

Description copied from interface: Progress

Set the ProgressBean.Type of the progress to ProgressBean.Type.CANCELLED, display the given label and display the default notification (ProgressBean.DEFAULT_CANCELLED_NOTIFICATION).

Specified by:

updateCancelled in interface Progress

Parameters:

labelKey - the key (text resources) of the label to display

vars - a map with the parameters to replace the placeholders in the label with.

updateCancelled

public void updateCancelled(String labelKey,
 String notificationKey)

Description copied from interface: Progress

Set the ProgressBean.Type of the progress to ProgressBean.Type.CANCELLED and display the given label and notification.

Specified by:

updateCancelled in interface Progress

Parameters:

labelKey - the key (text resources) of the label to display

notificationKey - the key (text resources) of the notification to display

updateCancelled

public void updateCancelled(String labelKey,
 String notificationKey,
 Map<String,String> vars)

Description copied from interface: Progress

Set the ProgressBean.Type of the progress to ProgressBean.Type.CANCELLED and display the given label and notification.

Specified by:

updateCancelled in interface Progress

Parameters:

labelKey - the key (text resources) of the label to display

notificationKey - the key (text resources) of the notification to display

vars - a map with the parameters to replace the placeholders in the label and also in the notification with.

getTaskId

public String getTaskId()

Description copied from interface: Progress

Get the id of the task.

Specified by:

getTaskId in interface Progress

Returns:

the id of the task

getType

public ProgressBean.Type getType()

Description copied from interface: Progress

Get the ProgressBean.Type of the progress.

Specified by:

getType in interface Progress

Returns:

the ProgressBean.Type

getLabelKey

public String getLabelKey()

Description copied from interface: Progress

Get the textresources key of the progress.

Specified by:

getLabelKey in interface Progress

Returns:

the textressources key

getVars

@Nullable
public @Nullable Map<String,String> getVars()

Description copied from interface: Progress

Get the variables (parameters for the placeholders in the label).

Specified by:

getVars in interface Progress

Returns:

the variables