com.sitewhere.rest.model.monitoring

Class ProgressMessage

java.lang.Object

com.sitewhere.rest.model.monitoring.ProgressMessage

All Implemented Interfaces:

IProgressMessage

public class ProgressMessage
extends java.lang.Object
implements IProgressMessage

Contains progress information provided by an ILifecycleProgressMonitor.

Constructor Summary

Constructors

Constructor and Description
ProgressMessage()
ProgressMessage(java.lang.String taskName, int totalOperations, int currentOperation, java.lang.String message)

Method Summary

Modifier and Type	Method and Description
int	getCurrentOperation() Get index of current operation.
java.lang.String	getMessage() Get message shown for current operation.
java.lang.String	getTaskName() Get name of overall task being monitored.
int	getTotalOperations() Get count of all operations to be performed.
void	setCurrentOperation(int currentOperation)
void	setMessage(java.lang.String message)
void	setTaskName(java.lang.String taskName)
void	setTotalOperations(int totalOperations)

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgressMessage

public ProgressMessage()

ProgressMessage

public ProgressMessage(java.lang.String taskName,
                       int totalOperations,
                       int currentOperation,
                       java.lang.String message)

Method Detail

getTaskName

public java.lang.String getTaskName()

Description copied from interface: IProgressMessage

Get name of overall task being monitored.

Specified by:

getTaskName in interface IProgressMessage

Returns:

setTaskName

public void setTaskName(java.lang.String taskName)

getTotalOperations

public int getTotalOperations()

Description copied from interface: IProgressMessage

Get count of all operations to be performed.

Specified by:

getTotalOperations in interface IProgressMessage

Returns:

setTotalOperations

public void setTotalOperations(int totalOperations)

getCurrentOperation

public int getCurrentOperation()

Description copied from interface: IProgressMessage

Get index of current operation.

Specified by:

getCurrentOperation in interface IProgressMessage

Returns:

setCurrentOperation

public void setCurrentOperation(int currentOperation)

getMessage

public java.lang.String getMessage()

Description copied from interface: IProgressMessage

Get message shown for current operation.

Specified by:

getMessage in interface IProgressMessage

Returns:

setMessage

public void setMessage(java.lang.String message)