From 2cd5b59772517f551a3fd11eef50a338e2de8b0f Mon Sep 17 00:00:00 2001 From: John Cortell Date: Mon, 1 Nov 2010 20:55:25 +0000 Subject: [PATCH] Documentation --- .../eclipse/cdt/dsf/concurrent/ICache.java | 23 +++++++++++-------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/dsf/org.eclipse.cdt.dsf/src/org/eclipse/cdt/dsf/concurrent/ICache.java b/dsf/org.eclipse.cdt.dsf/src/org/eclipse/cdt/dsf/concurrent/ICache.java index c9b18f2f7a8..a073480f96b 100644 --- a/dsf/org.eclipse.cdt.dsf/src/org/eclipse/cdt/dsf/concurrent/ICache.java +++ b/dsf/org.eclipse.cdt.dsf/src/org/eclipse/cdt/dsf/concurrent/ICache.java @@ -29,17 +29,20 @@ public interface ICache { * The executor that must be used to access this cache. */ public DsfExecutor getExecutor(); - - /** - * Returns the current data value held by this cache. Clients should first - * call isValid() to determine if the data is up to date. - */ + + /** + * Returns the current data value held by this cache. Clients should first + * call isValid() to determine if the data is up to date. Calling this when + * in the invalid state will throw an IllegalStateException + */ public V getData(); - - /** - * Returns the status of the source request held by this cache. Clients - * should first call isValid() to determine if the data is up to date. - */ + + /** + * Returns the status of the source request held by this cache. Clients + * should first call isValid() to determine if the data is up to date. + * Calling this when in the invalid state will throw an + * IllegalStateException + */ public IStatus getStatus(); /**