com.carrotgarden.eclipse.fileinstall.util.EclipseRunnable.java Source code

Introduction

Here is the source code for com.carrotgarden.eclipse.fileinstall.util.EclipseRunnable.java

Source

/*******************************************************************************
 * Copyright (c) 2012 VMWare, Inc.
 * 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:
 * VMWare, Inc. - initial API and implementation
 *******************************************************************************/
package com.carrotgarden.eclipse.fileinstall.util;

import java.lang.reflect.InvocationTargetException;

import org.eclipse.core.resources.WorkspaceJob;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.OperationCanceledException;
import org.eclipse.core.runtime.Status;
import org.eclipse.core.runtime.jobs.Job;
import org.eclipse.jface.operation.IRunnableWithProgress;

/**
 * Wrapper for long running operations, provides a way to turn the operation into
 * different types of "runnables" that exist within eclipse.
 * 
 * @author Kris De Volder
 */
public abstract class EclipseRunnable implements IRunnableWithProgress {

    protected String jobName = "Gradle Job " + generateId();
    private int jobCtr = 0;

    private synchronized int generateId() {
        return jobCtr++;
    }

    public EclipseRunnable(String jobName) {
        this.jobName = jobName;
    }

    public abstract void doit(IProgressMonitor mon) throws Exception;

    public Job asJob() {
        return new Job(jobName) {
            @Override
            protected IStatus run(IProgressMonitor monitor) {
                try {
                    doit(monitor);
                    return Status.OK_STATUS;
                } catch (Throwable e) {
                    return ExceptionUtil.status(e);
                }
            }

            @Override
            public Job yieldRule(IProgressMonitor monitor) { //Avoids a deadlocking problem when WTP tasks call yieldRule
                return null;
            }
        };
    }

    public WorkspaceJob asWorkspaceJob() {
        return new WorkspaceJob(jobName) {
            @Override
            public IStatus runInWorkspace(IProgressMonitor monitor) throws CoreException {
                try {
                    doit(monitor);
                    return Status.OK_STATUS;
                } catch (Throwable e) {
                    return ExceptionUtil.status(e);
                }
            }
        };
    }

    /**
     * This method is here so that GradleRunnable can be used as an {@link IRunnableWithProgress}. It is final
     * as you are not supposed to implement it directly. Implement the doit method instead.
     */
    public final void run(IProgressMonitor monitor) throws InvocationTargetException, InterruptedException {
        try {
            doit(monitor);
        } catch (InterruptedException e) {
            throw e;
        } catch (OperationCanceledException e) {
            throw new InterruptedException("Canceled by user");
        } catch (InvocationTargetException e) {
            throw e;
        } catch (Throwable e) {
            throw new InvocationTargetException(e);
        }
    }

    @Override
    public String toString() {
        return jobName;
    }

}