org.jboss.forge.addon.ui.progress

Class DefaultUIProgressMonitor

java.lang.Object

org.jboss.forge.addon.ui.progress.DefaultUIProgressMonitor

All Implemented Interfaces:

UIProgressMonitor

public class DefaultUIProgressMonitor
extends Object
implements UIProgressMonitor

Default implementation for UIProgressMonitor

Author:

George Gastaldi

Field Summary

Fields inherited from interface org.jboss.forge.addon.ui.progress.UIProgressMonitor

UNKNOWN

Constructor Summary

Constructors

Constructor and Description
DefaultUIProgressMonitor()

Method Summary

Methods

Modifier and Type	Method and Description
void	beginTask(String name, int totalWork) Notifies that the main task is beginning.
void	done() Notifies that the work is done; that is, either the main task is completed or the user canceled it.
int	getCurrentWork()
String	getSubtask()
String	getTaskName()
int	getTotalWork()
boolean	isCancelled() Returns whether cancellation of current operation has been requested.
void	setCancelled(boolean value) Sets the cancel state to the given value.
void	setTaskName(String name) Sets the task name to the given value.
void	subTask(String name) Notifies that a subtask of the main task is beginning.
void	worked(int work) Notifies that a given number of work unit of the main task has been completed.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultUIProgressMonitor

public DefaultUIProgressMonitor()

Method Detail

beginTask

public void beginTask(String name,
             int totalWork)

Description copied from interface: UIProgressMonitor

Notifies that the main task is beginning. This must only be called once on a given progress monitor instance.

Specified by:

beginTask in interface UIProgressMonitor

Parameters:

name - the name (or description) of the main task

totalWork - the total number of work units into which the main task is been subdivided. If the value is UNKNOWN the implementation is free to indicate progress in a way which doesn't require the total number of work units in advance.

done

public void done()

Description copied from interface: UIProgressMonitor

Notifies that the work is done; that is, either the main task is completed or the user canceled it. This method may be called more than once (implementations should be prepared to handle this case).

Specified by:

done in interface UIProgressMonitor

isCancelled

public boolean isCancelled()

Description copied from interface: UIProgressMonitor

Returns whether cancellation of current operation has been requested. Long-running operations should poll to see if cancelation has been requested.

Specified by:

isCancelled in interface UIProgressMonitor

Returns:

true if cancellation has been requested, and false otherwise

See Also:

UIProgressMonitor.setCancelled(boolean)

setCancelled

public void setCancelled(boolean value)

Description copied from interface: UIProgressMonitor

Sets the cancel state to the given value.

Specified by:

setCancelled in interface UIProgressMonitor

Parameters:

value - true indicates that cancellation has been requested (but not necessarily acknowledged); false clears this flag

See Also:

UIProgressMonitor.isCancelled()

setTaskName

public void setTaskName(String name)

Description copied from interface: UIProgressMonitor

Sets the task name to the given value. This method is used to restore the task label after a nested operation was executed. Normally there is no need for clients to call this method.

Specified by:

setTaskName in interface UIProgressMonitor

Parameters:

name - the name (or description) of the main task

See Also:

UIProgressMonitor.beginTask(java.lang.String, int)

subTask

public void subTask(String name)

Description copied from interface: UIProgressMonitor

Notifies that a subtask of the main task is beginning. Subtasks are optional; the main task might not have subtasks.

Specified by:

subTask in interface UIProgressMonitor

Parameters:

name - the name (or description) of the subtask

worked

public void worked(int work)

Description copied from interface: UIProgressMonitor

Notifies that a given number of work unit of the main task has been completed. Note that this amount represents an installment, as opposed to a cumulative amount of work done to date.

Specified by:

worked in interface UIProgressMonitor

Parameters:

work - a non-negative number of work units just completed

getTaskName

public String getTaskName()

getTotalWork

public int getTotalWork()

getCurrentWork

public int getCurrentWork()

getSubtask

public String getSubtask()