Class StatusProgressMonitor
- java.lang.Object
-
- org.esa.snap.core.dataop.downloadable.StatusProgressMonitor
-
- All Implemented Interfaces:
ProgressMonitor
public final class StatusProgressMonitor extends Object implements ProgressMonitor
status bar Progress monitor This is used for showing progress on sub threads within an operator execution
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
StatusProgressMonitor.Listener
static class
StatusProgressMonitor.Notification
static class
StatusProgressMonitor.TYPE
-
Field Summary
-
Fields inherited from interface com.bc.ceres.core.ProgressMonitor
NULL, UNKNOWN
-
-
Constructor Summary
Constructors Constructor Description StatusProgressMonitor()
StatusProgressMonitor(StatusProgressMonitor.TYPE taskType)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addListener(StatusProgressMonitor.Listener listener)
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.protected void
finalize()
int
getMax()
String
getName()
int
getPercentComplete()
StatusProgressMonitor.TYPE
getTaskType()
String
getText()
void
internalWorked(double work)
Internal method to handle scaling correctly.boolean
isCanceled()
Returns whether cancelation of current operation has been requested.void
setCanceled(boolean canceled)
Sets the cancel state to the given value.void
setSubTaskName(String subTaskName)
Notifies that a subtask of the main task is beginning.void
setTaskName(String taskName)
Sets the task name to the given value.void
worked(int work)
Notifies that a given number of work unit of the main task has been completed.
-
-
-
Constructor Detail
-
StatusProgressMonitor
public StatusProgressMonitor()
-
StatusProgressMonitor
public StatusProgressMonitor(StatusProgressMonitor.TYPE taskType)
-
-
Method Detail
-
finalize
protected void finalize() throws Throwable
-
beginTask
public void beginTask(String name, int totalWork)
Notifies that the main task is beginning. This must only be called once on a given progress monitor instance.- Specified by:
beginTask
in interfaceProgressMonitor
- Parameters:
name
- the name (or description) of the main tasktotalWork
- the total number of work units into which the main task is been subdivided. If the value isUNKNOWN
the implementation is free to indicate progress in a way which doesn't require the total number of work units in advance.
-
internalWorked
public void internalWorked(double work)
Internal method to handle scaling correctly. This method must not be called by a client. Clients should always use the methodworked(int)
.- Specified by:
internalWorked
in interfaceProgressMonitor
- Parameters:
work
- the amount of work done
-
isCanceled
public boolean isCanceled()
Returns whether cancelation of current operation has been requested. Long-running operations should poll to see if cancelation has been requested.- Specified by:
isCanceled
in interfaceProgressMonitor
- Returns:
true
if cancellation has been requested, andfalse
otherwise- See Also:
setCanceled(boolean)
-
setCanceled
public void setCanceled(boolean canceled)
Sets the cancel state to the given value.- Specified by:
setCanceled
in interfaceProgressMonitor
- Parameters:
canceled
-true
indicates that cancelation has been requested (but not necessarily acknowledged);false
clears this flag- See Also:
isCanceled()
-
setTaskName
public void setTaskName(String taskName)
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 interfaceProgressMonitor
- Parameters:
taskName
- the name (or description) of the main task- See Also:
beginTask(String, int)
-
setSubTaskName
public void setSubTaskName(String subTaskName)
Description copied from interface:ProgressMonitor
Notifies that a subtask of the main task is beginning. Subtasks are optional; the main task might not have subtasks.- Specified by:
setSubTaskName
in interfaceProgressMonitor
- Parameters:
subTaskName
- the name (or description) of the subtask
-
worked
public void worked(int work)
Description copied from interface:ProgressMonitor
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 interfaceProgressMonitor
- Parameters:
work
- the number of work units just completed
-
done
public void done()
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 interfaceProgressMonitor
-
getText
public String getText()
-
getName
public String getName()
-
getTaskType
public StatusProgressMonitor.TYPE getTaskType()
-
getMax
public int getMax()
-
getPercentComplete
public int getPercentComplete()
-
addListener
public void addListener(StatusProgressMonitor.Listener listener)
-
-