aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorOleg Besedin2012-02-24 11:33:17 (EST)
committerOleg Besedin2012-02-24 11:33:17 (EST)
commit392ba48cd214dff27f4229d6d63a63acb640c69d (patch)
tree6c8e4a022b825af213e8980c5b556b2dfd2e74e5
parent415730bef94c5160d7bce6c682ba1267055f0c7d (diff)
downloadeclipse.platform.runtime-392ba48cd214dff27f4229d6d63a63acb640c69d.zip
eclipse.platform.runtime-392ba48cd214dff27f4229d6d63a63acb640c69d.tar.gz
eclipse.platform.runtime-392ba48cd214dff27f4229d6d63a63acb640c69d.tar.bz2
-rw-r--r--bundles/org.eclipse.e4.core.contexts/src/org/eclipse/e4/core/contexts/IEclipseContext.java22
1 files changed, 20 insertions, 2 deletions
diff --git a/bundles/org.eclipse.e4.core.contexts/src/org/eclipse/e4/core/contexts/IEclipseContext.java b/bundles/org.eclipse.e4.core.contexts/src/org/eclipse/e4/core/contexts/IEclipseContext.java
index 50015f3..8a6a19e 100644
--- a/bundles/org.eclipse.e4.core.contexts/src/org/eclipse/e4/core/contexts/IEclipseContext.java
+++ b/bundles/org.eclipse.e4.core.contexts/src/org/eclipse/e4/core/contexts/IEclipseContext.java
@@ -286,8 +286,17 @@ public interface IEclipseContext {
public void dispose();
/**
- * <STRONG>EXPERIMENTAL, DO NOT USE</STRONG>
* Returns the value stored on the active leaf node of the context's tree.
+ * <p>
+ * This method is similar to <code>getActiveLeaf().get(clazz)</code> but optimized
+ * for a large number of repeat invocations.
+ * </p>
+ * <p>Use this method in code paths that are going to receive a large number
+ * of repeat calls, such as inside {@link RunAndTrack#changed(IEclipseContext)}.
+ * </p>
+ * <p>In the code paths that won't be cycled through large number of times,
+ * consider using <code>getActiveLeaf().get(clazz)</code>.
+ * </p>
* @param clazz the class that needs to be found in the active context
* @return an object corresponding to the given class, or <code>null</code>
* @see IEclipseContext#getActiveLeaf()
@@ -295,8 +304,17 @@ public interface IEclipseContext {
public <T> T getActive(Class<T> clazz);
/**
- * <STRONG>EXPERIMENTAL, DO NOT USE</STRONG>
* Returns the named value stored on the active leaf node of the context's tree.
+ * <p>
+ * This method is similar to <code>getActiveLeaf().get(name)</code> but optimized
+ * for a large number of repeat invocations.
+ * </p>
+ * <p>Use this method in code paths that are going to receive a large number
+ * of repeat calls, such as inside {@link RunAndTrack#changed(IEclipseContext)}.
+ * </p>
+ * <p>In the code paths that won't be cycled through large number of times,
+ * consider using <code>getActiveLeaf().get(name)</code>.
+ * </p>
* @param name the name of the value to return
* @return an object corresponding to the given name, or <code>null</code>
* @see IEclipseContext#getActiveLeaf()