public interface IJob
Modifier and Type | Field and Description |
---|---|
static int |
JOB_CANCELLED
flag that represents that a job could not finish and has been cancelled
|
static int |
JOB_FINISHED
flag that represents that a job has finished without beeing cancelled
|
static int |
MODE_BACKGROUND
background mode for a job.
|
static int |
MODE_FOREGROUND
foreground mode for a job.
|
static int |
PRIORITY_HIGH
high priority flag for a job
|
static int |
PRIORITY_LOW
low priority flag for a job
|
static int |
PRIORITY_NORMAL
default priority flag for a job
|
Modifier and Type | Method and Description |
---|---|
void |
cancel()
This method is called if the job has to be cancelled.
|
String |
getDescription()
Returns a detailed description of what the job is doing.
|
int |
getMode()
Retunrs the mode of the job.
|
String |
getName()
Returns the name of the job.
|
int |
getPriority()
Returns the priority of the job.
|
boolean |
needLoggerConsole()
Returns true if the job want to have a logger console for output at
runtime.
|
int |
run(ILogger logger,
IProgressMonitor monitor)
Starts the job.
|
static final int PRIORITY_LOW
static final int PRIORITY_NORMAL
static final int PRIORITY_HIGH
static final int MODE_FOREGROUND
static final int MODE_BACKGROUND
static final int JOB_FINISHED
static final int JOB_CANCELLED
int run(ILogger logger, IProgressMonitor monitor) throws JobRuntimeException
logger
- a logger that is connected with a console for this jobmonitor
- a progress monitor that should be used by the job to indicate
its progress while workingJobRuntimeException
void cancel()
String getName()
String getDescription()
int getMode()
int getPriority()
boolean needLoggerConsole()