mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-07-15 13:05:22 +02:00
Code Issues Wiki Activity

[244807] Improve ISubSystem#checkIsConnected() docs for offline and cache manager cases

Browse source
This commit is contained in:
Martin Oberhuber 2008-09-04 10:04:45 +00:00
parent fe47b4e2fc
commit 44fa95babb
1 changed files with 9 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/subsystems/ISubSystem.java
View file

@ -105,7 +105,7 @@ public interface ISubSystem extends ISystemFilterPoolReferenceManagerProvider, I
/** /**
* Called on each subsystem associated with a particular * Called on each subsystem associated with a particular
* {@link IConnectorService} after it disconnects * {@link IConnectorService} after it disconnects
* *
* @param monitor a progress monitor that can be used to show progress * @param monitor a progress monitor that can be used to show progress
* during long-running operation. Cancellation is typically not * during long-running operation. Cancellation is typically not
* supported since it might leave the system in an inconsistent * 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. * Check if the subsystem is connected, and connect if it's not.
* *
* This is a convenience method which first checks whether the subsystem is * 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 * already connected. If not, it automatically checks if it's running on the
* dispatch thread or not, and calls the right <code>connect()</code> * dispatch thread or not, and calls the right <code>connect()</code> method
* method as appropriate. It also performs some exception parsing, * as appropriate. It also performs some exception parsing, converting
* converting Exceptions from connect() into SystemMessageException that can * Exceptions from connect() into SystemMessageException that can be
* be displayed to the user by using a method in it. * 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 * @throws SystemMessageException in case of an error connecting
* @since org.eclipse.rse.core 3.0 * @since org.eclipse.rse.core 3.0
*/ */