org.eclipse.egit.core/src/org/eclipse/egit/core/op/IEGitOperation.java

   1 /*******************************************************************************
   2  * Copyright (C) 2010, Jens Baumgart <jens.baumgart@sap.com>
   3  *
   4  * All rights reserved. This program and the accompanying materials
   5  * are made available under the terms of the Eclipse Public License v1.0
   6  * which accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *******************************************************************************/
   9 package org.eclipse.egit.core.op;
  10
  11 import org.eclipse.core.resources.IResourceRuleFactory;
  12 import org.eclipse.core.runtime.CoreException;
  13 import org.eclipse.core.runtime.IProgressMonitor;
  14 import org.eclipse.core.runtime.jobs.ISchedulingRule;
  15
  16 /**
  17  * interface for EGit operations
  18  *
  19  */
  20 public interface IEGitOperation {
  21         /**
  22          * Executes the operation
  23          *
  24          * @param monitor
  25          *            a progress monitor, or <code>null</code> if progress reporting
  26          *            and cancellation are not desired
  27          * @throws CoreException
  28          */
  29         void execute(IProgressMonitor monitor) throws CoreException;
  30
  31         /**
  32          * @return the rule needed to execute this operation.
  33          * <code>null</code> if no rule is required.
  34          * A rule is required if the operation changes resources.
  35          * It can also be useful to use a rule for reading resources to avoid
  36          * changes on the resources by other threads while the operation is running.
  37          * @see IResourceRuleFactory
  38          */
  39         ISchedulingRule getSchedulingRule();
  40 }