1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-07-15 21:15:23 +02:00

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

This commit is contained in:
Martin Oberhuber 2008-09-04 10:04:45 +00:00
parent fe47b4e2fc
commit 44fa95babb

View file

@ -157,10 +157,13 @@ public interface ISubSystem extends ISystemFilterPoolReferenceManagerProvider, I
* *
* 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