Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJens Baumgart2010-05-25 15:44:29 +0000
committerJens Baumgart2010-05-25 15:44:29 +0000
commit4462355dd3a380603618c3e411818a12723eada3 (patch)
tree16d9f6734dd4ad826ae63b8ebd54429983985f6c
parent055dec2839120054cf2d09c280c141b751e8dee1 (diff)
downloadegit-4462355dd3a380603618c3e411818a12723eada3.tar.gz
egit-4462355dd3a380603618c3e411818a12723eada3.tar.xz
egit-4462355dd3a380603618c3e411818a12723eada3.zip
Improve JavaDoc of IEGitOperation
JavaDoc of method getSchedulingRule was extended. Bug: 312768 Signed-off-by: Jens Baumgart <jens.baumgart@sap.com>
-rw-r--r--org.eclipse.egit.core/src/org/eclipse/egit/core/op/IEGitOperation.java5
1 files changed, 5 insertions, 0 deletions
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 f932442e23..4befeaaf3a 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.
* <code>null</code> 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();
}

Back to the top