/*******************************************************************************
* Copyright (c) 2003, 2006 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM - Initial API and implementation
*******************************************************************************/
package org.eclipse.ui.progress;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.jobs.IJobChangeEvent;
import org.eclipse.core.runtime.jobs.JobChangeAdapter;
import org.eclipse.swt.widgets.Display;
import org.eclipse.ui.PlatformUI;
/**
* WorkbenchJob is a type of job that implements a done listener
* and does the shutdown checks before scheduling. This is used if
* a job is not meant to run when the Workbench is shutdown.
* @since 3.0
*/
public abstract class WorkbenchJob extends UIJob {
/**
* Create a new instance of the receiver with the
* supplied display and name.
* Normally this constructor would not be used as
* it is best to let the job find the display from
* the workbench
* @param jobDisplay Display. The display to run the
* job with.
* @param name String
*/
public WorkbenchJob(Display jobDisplay, String name) {
super(jobDisplay, name);
addDefaultJobChangeListener();
}
/**
* Add a new instance of the reciever with the
* supplied name.
* @param name String
*/
public WorkbenchJob(String name) {
super(name);
addDefaultJobChangeListener();
}
/**
* Add a job change listeners that handles a done
* event if the result was IStatus.OK.
*
*/
private void addDefaultJobChangeListener() {
addJobChangeListener(new JobChangeAdapter() {
/* (non-Javadoc)
* @see org.eclipse.core.runtime.jobs.JobChangeAdapter#done(org.eclipse.core.runtime.jobs.IJobChangeEvent)
*/
public void done(IJobChangeEvent event) {
//Abort if it is not running
if (!PlatformUI.isWorkbenchRunning()) {
return;
}
if (event.getResult().getCode() == IStatus.OK) {
performDone(event);
}
}
});
}
/**
* Perform done with the supplied event. This will
* only occur if the returned status was OK.
* This is called only if the job is finished with an IStatus.OK
* result and the workbench is still running.
* @param event IJobChangeEvent
*/
public void performDone(IJobChangeEvent event) {
//Do nothing by default.
}
/* (non-Javadoc)
* @see org.eclipse.core.internal.jobs.InternalJob#shouldSchedule()
*/
public boolean shouldSchedule() {
return super.shouldSchedule() && PlatformUI.isWorkbenchRunning();
}
/* (non-Javadoc)
* @see org.eclipse.core.runtime.jobs.Job#shouldRun()
*/
public boolean shouldRun() {
return super.shouldRun() && PlatformUI.isWorkbenchRunning();
}
}