public abstract class CompilationProgress extends Object
BatchCompiler
to report progress during compilation.
It is also used to request cancellation of the compilation.
Clients of the BatchCompiler
should subclass this class, instantiate the subclass and pass this instance to
BatchCompiler.compile(String, java.io.PrintWriter, java.io.PrintWriter, CompilationProgress)
.
This class is intended to be instantiated and subclassed by clients.
Constructor and Description |
---|
CompilationProgress() |
Modifier and Type | Method and Description |
---|---|
abstract void |
begin(int remainingWork)
Notifies that the compilation is beginning.
|
abstract void |
done()
Notifies that the work is done; that is, either the compilation is completed
or a cancellation was requested.
|
abstract boolean |
isCanceled()
Returns whether cancellation of the compilation has been requested.
|
abstract void |
setTaskName(String name)
Reports the name (or description) of the current task.
|
abstract void |
worked(int workIncrement,
int remainingWork)
Notifies that a given amount of work of the compilation
has been completed.
|
public abstract void begin(int remainingWork)
worked(int, int)
.
Clients should not call this method.
remainingWork
- the estimated amount of remaining work.public abstract void done()
Clients should not call this method.
public abstract boolean isCanceled()
true
if cancellation has been requested,
and false
otherwisepublic abstract void setTaskName(String name)
Clients should not call this method.
name
- the name (or description) of the current taskpublic abstract void worked(int workIncrement, int remainingWork)
Clients should not call this method.
workIncrement
- a non-negative amount of work just completedremainingWork
- a non-negative amount of estimated remaining work
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.