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

[212403] [apidoc][breaking] Fixing docs of SubSystem#getConnectorService() and making internalConnect() private

Browse source
This commit is contained in:
David McKnight 2007-12-10 21:51:59 +00:00
parent 3bbb5862a4
commit 42324f2e58
1 changed files with 21 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

52
rse/plugins/org.eclipse.rse.ui/subsystems/org/eclipse/rse/core/subsystems/SubSystem.java
View file

@ -27,6 +27,7 @@
* David McKnight (IBM) - [186363] remove deprecated calls in checkIsConnected * David McKnight (IBM) - [186363] remove deprecated calls in checkIsConnected
* David McKnight (IBM) - [186363] get rid of obsolete calls to SubSystem.connect() * David McKnight (IBM) - [186363] get rid of obsolete calls to SubSystem.connect()
* David McKnight (IBM) - [211472] [api][breaking] IRemoteObjectResolver.getObjectWithAbsoluteName() needs a progress monitor * David McKnight (IBM) - [211472] [api][breaking] IRemoteObjectResolver.getObjectWithAbsoluteName() needs a progress monitor
* David McKnight (IBM) - [212403] [apidoc][breaking] Fixing docs of SubSystem#getConnectorService() and making internalConnect() private
********************************************************************************/ ********************************************************************************/
package org.eclipse.rse.core.subsystems; package org.eclipse.rse.core.subsystems;
@ -2420,35 +2421,26 @@ public abstract class SubSystem extends RSEModelObject
return null; return null;
} }
// ----------------------------------
// METHODS THAT MUST BE OVERRIDDEN...
// ----------------------------------
/** /**
* Return the {@link org.eclipse.rse.core.subsystems.IConnectorService IConnectorService} object that represents the live connection for this system. * Return the {@link org.eclipse.rse.core.subsystems.IConnectorService IConnectorService} object that represents the live connection for this system.
* This must return an object that implements {@link IConnectorService}. A good starting point for that * This must return an object that implements {@link IConnectorService}. A good starting point for that
* is the base class {@link AbstractConnectorService}. * is the base class {@link AbstractConnectorService}.
* <p>If you only have a single subsystem class, you may override this method to return the *
* IConnectorService object that manages the connect/disconnect actions. If, on the other hand, * The connector service gets passed in to the constructor for the subsystem so there's normally no reason
* you have multiple subsystem classes that desire to share a single IConnectorService connection, * to override this method.
* (ie, share the same communications pipe) then do not override this. By default, this *
* calls getSystemManager() which returns an {@link AbstractConnectorServiceManager} object that manages maintaining a singleton
* IConnectorService object per system connection. You should subclass AbstractSystemManager,
* and override getSystemManager() to return a singleton instance of that subclass.
* <p>Default implementation:</p>
* <pre><code>
* return getSystemManager().getSystemObject(this);
* </code></pre>
*
* <p>We recommending using a subclass of {@link AbstractConnectorServiceManager} even for single
* subsystems, because it doesn't hurt and allows easy growth if new subsystems
* are added in the future.
*/ */
public IConnectorService getConnectorService() public IConnectorService getConnectorService()
{ {
return _connectorService; return _connectorService;
} }
/**
* Sets the {@link org.eclipse.rse.core.subsystems.IConnectorService IConnectorService} object that represents the live connection for this system.
*
* @param connectorService the connector service
*/
public void setConnectorService(IConnectorService connectorService) public void setConnectorService(IConnectorService connectorService)
{ {
if (_connectorService != connectorService) if (_connectorService != connectorService)
@ -2464,7 +2456,9 @@ public abstract class SubSystem extends RSEModelObject
} }
} }
// ----------------------------------
// METHODS THAT MUST BE OVERRIDDEN...
// ----------------------------------
/** /**
@ -2488,10 +2482,8 @@ public abstract class SubSystem extends RSEModelObject
} }
/** /**
* Connect to the remote host. This is called by the run(IProgressMonitor monitor) method. * Connect to the remote host. This is called by the implicitConnect(boolean, IProgressMonitor, String, int) method.
* <p> * Rather, this calls connect(IProgressMonitor) in the IConnectorService class that is returned from getConnectorService().
* DO NOT OVERRIDE THIS. Rather, this calls connect(IProgressMonitor) in the
* IConnectorService class that is returned from getConnectorService().
* <p> * <p>
* Your connect method in your IConnectorService class must follow these IRunnableWithProgress rules: * Your connect method in your IConnectorService class must follow these IRunnableWithProgress rules:
* <ul> * <ul>
@ -2502,7 +2494,7 @@ public abstract class SubSystem extends RSEModelObject
* </ul> * </ul>
* *
*/ */
protected void internalConnect(IProgressMonitor monitor) private void internalConnect(IProgressMonitor monitor)
throws InvocationTargetException, InterruptedException throws InvocationTargetException, InterruptedException
{ {
try try
@ -2949,18 +2941,16 @@ public abstract class SubSystem extends RSEModelObject
return; return;
} }
/*
* (non-Javadoc)
* @see org.eclipse.rse.core.subsystems.ISubSystem#isPrimarySubSystem()
*/
public boolean isPrimarySubSystem() public boolean isPrimarySubSystem()
{ {
return false; return false;
} }
/* /*
* (non-Javadoc) * Returns the first subsystem associated with the connection
* @see org.eclipse.rse.core.subsystems.ISubSystem#getPrimarySubSystem()
*/ */
public ISubSystem getPrimarySubSystem() public ISubSystem getPrimarySubSystem()
{ {