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

[cleanup] Improve Javadoc of RemoteCommandShellOperation

Browse source
This commit is contained in:
Martin Oberhuber 2008-12-04 16:40:29 +00:00
parent 448c966004
commit 6acf667c72
2 changed files with 67 additions and 67 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
releng/org.eclipse.rse.build/maps/rse.map
View file

@ -53,7 +53,7 @@ plugin@org.eclipse.rse.subsystems.processes.core=v20080529,:pserver:anonymous:no
plugin@org.eclipse.rse.subsystems.processes.dstore=v20080604,:pserver:anonymous:none@dev.eclipse.org:/cvsroot/dsdp,,org.eclipse.tm.rse/plugins/org.eclipse.rse.subsystems.processes.dstore
plugin@org.eclipse.rse.subsystems.processes.local=v20080604,:pserver:anonymous:none@dev.eclipse.org:/cvsroot/dsdp,,org.eclipse.tm.rse/plugins/org.eclipse.rse.subsystems.processes.local
plugin@org.eclipse.rse.subsystems.processes.shell.linux=v20080714,:pserver:anonymous:none@dev.eclipse.org:/cvsroot/dsdp,,org.eclipse.tm.rse/plugins/org.eclipse.rse.subsystems.processes.shell.linux
plugin@org.eclipse.rse.subsystems.shells.core=v200811251700,:pserver:anonymous:none@dev.eclipse.org:/cvsroot/dsdp,,org.eclipse.tm.rse/plugins/org.eclipse.rse.subsystems.shells.core
plugin@org.eclipse.rse.subsystems.shells.core=v200812041630,:pserver:anonymous:none@dev.eclipse.org:/cvsroot/dsdp,,org.eclipse.tm.rse/plugins/org.eclipse.rse.subsystems.shells.core
plugin@org.eclipse.rse.subsystems.shells.dstore=v20080604,:pserver:anonymous:none@dev.eclipse.org:/cvsroot/dsdp,,org.eclipse.tm.rse/plugins/org.eclipse.rse.subsystems.shells.dstore
plugin@org.eclipse.rse.subsystems.shells.local=v20080604,:pserver:anonymous:none@dev.eclipse.org:/cvsroot/dsdp,,org.eclipse.tm.rse/plugins/org.eclipse.rse.subsystems.shells.local
plugin@org.eclipse.rse.subsystems.shells.ssh=v20080604,:pserver:anonymous:none@dev.eclipse.org:/cvsroot/dsdp,,org.eclipse.tm.rse/plugins/org.eclipse.rse.subsystems.shells.ssh

38
rse/plugins/org.eclipse.rse.subsystems.shells.core/src/org/eclipse/rse/subsystems/shells/core/model/RemoteCommandShellOperation.java
View file

@ -1,5 +1,5 @@
/********************************************************************************
* Copyright (c) 2006, 2007 IBM Corporation and others. All rights reserved.
* Copyright (c) 2006, 2008 IBM Corporation and others. All rights reserved.
* This program and the accompanying materials are made available under the terms
* of the Eclipse Public License v1.0 which accompanies this distribution, and is
* available at http://www.eclipse.org/legal/epl-v10.html
@ -35,14 +35,12 @@ import org.eclipse.rse.ui.SystemBasePlugin;
import org.eclipse.rse.ui.model.ISystemShellProvider;
import org.eclipse.swt.widgets.Shell;
/*
* This abstract class can be extended to provide a command shell wrapper.
* When running a shell, commands can be piped to the shell via the
* sendCommand() method. Echo commands are used to determine when each command
* is complete. Whenever a command completes, the handleCommandFinished() method
* is called.
/**
* Base class for command shell wrappers that use echo markers to parse command finish.
* This abstract class can be extended to provide a command shell wrapper. When
* running a shell, commands can be piped to the shell via the sendCommand()
* method. Echo commands are used to determine when each command is complete.
* Whenever a command completes, the handleCommandFinished() method is called.
*
*/
public abstract class RemoteCommandShellOperation
@ -83,7 +81,7 @@ public abstract class RemoteCommandShellOperation
private Random _random;
/*
/**
* Constructor
*/
public RemoteCommandShellOperation(Shell shell, IRemoteCmdSubSystem cmdSubSystem, IRemoteFile pwd)
@ -101,7 +99,7 @@ public abstract class RemoteCommandShellOperation
_pwd = pwd;
}
/*
/**
* Launches a new remote shell
*/
public IRemoteCommandShell run()
@ -131,7 +129,7 @@ public abstract class RemoteCommandShellOperation
}
}
/*
/**
* Called when a shell is complete.
*/
public void finish()
@ -270,7 +268,7 @@ public abstract class RemoteCommandShellOperation
}
/**
* Called whenever output is retrieved from the host
* Called (on the main Thread) whenever output is retrieved from the host
*/
public void outputUpdated()
{
@ -334,22 +332,24 @@ public abstract class RemoteCommandShellOperation
return false;
}
/*
* Called when the shell is complete
/**
* Called (on the main Thread) when the shell is complete
*/
public void handleShellFinished()
{
finish();
}
/*
* Called when the specified command is complete
/**
* Called (on the main Thread) when the specified command is complete
*
* @param cmd the completed command
*/
public abstract void handleCommandFinished(String cmd);
/*
* Called whenever output has changed
/**
* Called (on the main Thread) whenever output has changed
*
* @param command the current command
* @param output the new output object
*/