ProgressMonitor
public abstract class EmptyProgressMonitor extends Object implements ProgressMonitor
Could be used in scenarios when only some of the progress notifications are important and others can be ignored.
UNKNOWN
Constructor | Description |
---|---|
EmptyProgressMonitor() |
Modifier and Type | Method | Description |
---|---|---|
void |
beginTask(String title,
int totalWork) |
Begin processing a single task.
|
void |
endTask() |
Finish the current task, so the next can begin.
|
boolean |
isCancelled() |
Check for user task cancellation.
|
void |
start(int totalTasks) |
Advise the monitor of the total number of subtasks.
|
void |
update(int completed) |
Denote that some work units have been completed.
|
public void start(int totalTasks)
ProgressMonitor
This should be invoked at most once per progress monitor interface.
start
in interface ProgressMonitor
totalTasks
- the total number of tasks the caller will need to complete
their processing.public void beginTask(String title, int totalWork)
ProgressMonitor
beginTask
in interface ProgressMonitor
title
- title to describe the task. Callers should publish these as
stable string constants that implementations could match
against for translation support.totalWork
- total number of work units the application will perform;
ProgressMonitor.UNKNOWN
if it cannot be predicted in advance.public void update(int completed)
ProgressMonitor
This is an incremental update; if invoked once per work unit the correct
value for our argument is 1
, to indicate a single unit of
work has been finished by the caller.
update
in interface ProgressMonitor
completed
- the number of work units completed since the last call.public void endTask()
ProgressMonitor
endTask
in interface ProgressMonitor
public boolean isCancelled()
ProgressMonitor
isCancelled
in interface ProgressMonitor
Copyright © 2018. All rights reserved.