com.google.dart.tools.ui.internal.actions.WorkbenchRunnableAdapter_OLD.java Source code

Introduction

Here is the source code for com.google.dart.tools.ui.internal.actions.WorkbenchRunnableAdapter_OLD.java

Source

/*
 * Copyright (c) 2011, the Dart project authors.
 * 
 * Licensed under the Eclipse Public License v1.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 * 
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
package com.google.dart.tools.ui.internal.actions;

import com.google.dart.tools.core.DartCore;
import com.google.dart.tools.ui.DartToolsPlugin;

import org.eclipse.core.resources.IWorkspaceRunnable;
import org.eclipse.core.resources.ResourcesPlugin;
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.ISchedulingRule;
import org.eclipse.core.runtime.jobs.Job;
import org.eclipse.jface.operation.IRunnableContext;
import org.eclipse.jface.operation.IRunnableWithProgress;
import org.eclipse.jface.operation.IThreadListener;

import java.lang.reflect.InvocationTargetException;

/**
 * An {@link IRunnableWithProgress} that adapts an {@link IWorkspaceRunnable} so that is can be
 * executed inside an {@link IRunnableContext}. The runnable is run as an
 * {@linkplain JavaCore#run(IWorkspaceRunnable, ISchedulingRule, IProgressMonitor) atomic Java model
 * operation}.
 * <p>
 * {@link OperationCanceledException}s thrown by the adapted runnable are caught and re-thrown as
 * {@link InterruptedException}s.
 */
public class WorkbenchRunnableAdapter_OLD implements IRunnableWithProgress, IThreadListener {

    private boolean fTransfer = false;
    private final IWorkspaceRunnable fWorkspaceRunnable;
    private final ISchedulingRule fRule;

    /**
     * Runs a workspace runnable with the workspace lock.
     * 
     * @param runnable the runnable
     */
    public WorkbenchRunnableAdapter_OLD(IWorkspaceRunnable runnable) {
        this(runnable, ResourcesPlugin.getWorkspace().getRoot());
    }

    /**
     * Runs a workspace runnable with the given lock or <code>null</code> to run with no lock at all.
     * 
     * @param runnable the runnable
     * @param rule the scheduling rule, or <code>null</code>
     */
    public WorkbenchRunnableAdapter_OLD(IWorkspaceRunnable runnable, ISchedulingRule rule) {
        fWorkspaceRunnable = runnable;
        fRule = rule;
    }

    /**
     * Runs a workspace runnable with the given lock or <code>null</code> to run with no lock at all.
     * 
     * @param runnable the runnable
     * @param rule the scheduling rule, or <code>null</code>
     * @param transfer <code>true</code> iff the rule is to be transfered to the modal context thread
     */
    public WorkbenchRunnableAdapter_OLD(IWorkspaceRunnable runnable, ISchedulingRule rule, boolean transfer) {
        fWorkspaceRunnable = runnable;
        fRule = rule;
        fTransfer = transfer;
    }

    /**
     * Returns the scheduling rule, or <code>null</code> if none.
     * 
     * @return the scheduling rule, or <code>null</code> if none
     */
    public ISchedulingRule getSchedulingRule() {
        return fRule;
    }

    /*
     * @see IRunnableWithProgress#run(IProgressMonitor)
     */
    @Override
    public void run(IProgressMonitor monitor) throws InvocationTargetException, InterruptedException {
        try {
            DartCore.run(fWorkspaceRunnable, fRule, monitor);
        } catch (OperationCanceledException e) {
            throw new InterruptedException(e.getMessage());
        } catch (CoreException e) {
            throw new InvocationTargetException(e);
        }
    }

    public void runAsUserJob(String name, final Object jobFamiliy) {
        Job job = new Job(name) {
            @Override
            public boolean belongsTo(Object family) {
                return jobFamiliy == family;
            }

            /*
             * (non-Javadoc)
             * 
             * @see org.eclipse.core.runtime.jobs.Job#run(org.eclipse.core.runtime. IProgressMonitor)
             */
            @Override
            protected IStatus run(IProgressMonitor monitor) {
                try {
                    WorkbenchRunnableAdapter_OLD.this.run(monitor);
                } catch (InvocationTargetException e) {
                    Throwable cause = e.getCause();
                    if (cause instanceof CoreException) {
                        return ((CoreException) cause).getStatus();
                    } else {
                        return new Status(IStatus.ERROR, DartToolsPlugin.PLUGIN_ID, IStatus.ERROR,
                                cause.getMessage(), cause);
                    }
                } catch (InterruptedException e) {
                    return Status.CANCEL_STATUS;
                } finally {
                    monitor.done();
                }
                return Status.OK_STATUS;
            }
        };
        job.setRule(fRule);
        job.setUser(true);
        job.schedule();

        // TODO: should block until user pressed 'to background'
    }

    @Override
    public void threadChange(Thread thread) {
        if (fTransfer) {
            Job.getJobManager().transferRule(fRule, thread);
        }
    }
}