State-carrying context API.

pkg/analyzer/lib/src/generated/engine.dart

 // Copyright (c) 2014, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 library engine;
 
 import 'dart:async';
 import 'dart:collection';
 import 'dart:math' as math;
 
@@ skipping 452 matching lines @@
    * comment is not cached.
    *
    * Throws an [AnalysisException] if the documentation comment could not be
    * determined because the analysis could not be performed.
    *
    * <b>Note:</b> This method cannot be used in an async environment.
    */
   String computeDocumentationComment(Element element);
 
   /**
+   * Return the stored state associated with the given object key.  In case no
+   * state has been associated with the given [key], returns `null`.
+   */
+  Object getState(Object key);
+
+  /**
    * Return a list containing all of the errors associated with the given
    * [source]. If the errors are not already known then the source will be
    * analyzed in order to determine the errors associated with it.
    *
    * Throws an [AnalysisException] if the errors could not be determined because
    * the analysis could not be performed.
    *
    * <b>Note:</b> This method cannot be used in an async environment.
    *
    * See [getErrors].
@@ skipping 404 matching lines @@
 
   /**
    * Set the contents of the given [source] to the given [contents] and mark the
    * source as having changed. This has the effect of overriding the default
    * contents of the source. If the contents are `null` the override is removed
    * so that the default contents will be returned.
    */
   void setContents(Source source, String contents);
 
   /**
+   * Associate this [state] object with the given state [key].

[Brian Wilkerson, 2015/10/13 20:50:58]

"state [key]" --> "[key]"

Perhaps a Dart-like @see: "Use the method [getState] to retrieve the value that
was set." (and another with 'getState').

+   */
+  void setState(Object key, Object state);
+
+  /**
    * Check the cache for any invalid entries (entries whose modification time
    * does not match the modification time of the source associated with the
    * entry). Invalid entries will be marked as invalid so that the source will
    * be re-analyzed. Return `true` if at least one entry was invalid.
    */
   bool validateCacheConsistency();
 }
 
 /**
  * An [AnalysisContext].
@@ skipping 11157 matching lines @@
     PendingFuture pendingFuture =
         new PendingFuture<T>(_context, source, computeValue);
     if (!pendingFuture.evaluate(sourceEntry)) {
       _context._pendingFutureSources
           .putIfAbsent(source, () => <PendingFuture>[])
           .add(pendingFuture);
     }
     return pendingFuture.future;
   }
 }