From 4462355dd3a380603618c3e411818a12723eada3 Mon Sep 17 00:00:00 2001 From: Jens Baumgart Date: Tue, 25 May 2010 17:44:29 +0200 Subject: [PATCH] Improve JavaDoc of IEGitOperation JavaDoc of method getSchedulingRule was extended. Bug: 312768 Signed-off-by: Jens Baumgart --- .../src/org/eclipse/egit/core/op/IEGitOperation.java | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/org.eclipse.egit.core/src/org/eclipse/egit/core/op/IEGitOperation.java b/org.eclipse.egit.core/src/org/eclipse/egit/core/op/IEGitOperation.java index f932442e..4befeaaf 100644 --- a/org.eclipse.egit.core/src/org/eclipse/egit/core/op/IEGitOperation.java +++ b/org.eclipse.egit.core/src/org/eclipse/egit/core/op/IEGitOperation.java @@ -8,6 +8,7 @@ *******************************************************************************/ package org.eclipse.egit.core.op; +import org.eclipse.core.resources.IResourceRuleFactory; import org.eclipse.core.runtime.CoreException; import org.eclipse.core.runtime.IProgressMonitor; import org.eclipse.core.runtime.jobs.ISchedulingRule; @@ -27,6 +28,10 @@ public interface IEGitOperation { /** * @return the rule needed to execute this operation. * null if no rule is required. + * A rule is required if the operation changes resources. + * It can also be useful to use a rule for reading resources to avoid + * changes on the resources by other threads while the operation is running. + * @see IResourceRuleFactory */ ISchedulingRule getSchedulingRule(); } -- 2.11.4.GIT