From 44fa95babb87fa22f1a5b69e02aea114d468f84a Mon Sep 17 00:00:00 2001
From: Martin Oberhuber < martin.oberhuber@windriver.com>
Date: Thu, 4 Sep 2008 10:04:45 +0000
Subject: [PATCH] [244807] Improve ISubSystem#checkIsConnected() docs for
 offline and cache manager cases

---
 .../eclipse/rse/core/subsystems/ISubSystem.java   | 15 +++++++++------
 1 file changed, 9 insertions(+), 6 deletions(-)

diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/subsystems/ISubSystem.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/subsystems/ISubSystem.java
index 4cd2ac9682d..f3c5ce798b0 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/subsystems/ISubSystem.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/subsystems/ISubSystem.java
@@ -105,7 +105,7 @@ public interface ISubSystem extends ISystemFilterPoolReferenceManagerProvider, I
 	/**
 	 * Called on each subsystem associated with a particular
 	 * {@link IConnectorService} after it disconnects
-	 * 
+	 *
 	 * @param monitor a progress monitor that can be used to show progress
 	 *            during long-running operation. Cancellation is typically not
 	 *            supported since it might leave the system in an inconsistent
@@ -154,14 +154,17 @@ public interface ISubSystem extends ISystemFilterPoolReferenceManagerProvider, I
 
 	/**
 	 * Check if the subsystem is connected, and connect if it's not.
-	 *
+	 * 
 	 * This is a convenience method which first checks whether the subsystem is
 	 * already connected. If not, it automatically checks if it's running on the
-	 * dispatch thread or not, and calls the right <code>connect()</code>
-	 * method as appropriate. It also performs some exception parsing,
-	 * converting Exceptions from connect() into SystemMessageException that can
-	 * be displayed to the user by using a method in it.
+	 * dispatch thread or not, and calls the right <code>connect()</code> method
+	 * as appropriate. It also performs some exception parsing, converting
+	 * Exceptions from connect() into SystemMessageException that can be
+	 * displayed to the user by using a method in it.
 	 *
+	 * If the subsystem is marked offline, or supports caching and is currently
+	 * restoring from its memento, no connect will be performed.
+	 * 
 	 * @throws SystemMessageException in case of an error connecting
 	 * @since org.eclipse.rse.core 3.0
 	 */