org.eclipse.rse.subsystems.shells.core.subsystems
Interface IRemoteCommandShell

All Known Subinterfaces:

IServiceCommandShell

All Known Implementing Classes:

org.eclipse.rse.internal.subsystems.shells.subsystems.RemoteCommandShell, ServiceCommandShell

public interface IRemoteCommandShell

This interface represents a handle to a remote command, which is either a transient command or a command shell.

Method Summary

void	addOutput(Object output) Add an output object to the list of output for this command
void	associateProject(IProject project)
IProject	getAssociatedProject()
ICandidateCommand[]	getCandidateCommands() Return the list of possible commands for this command shell
IRemoteCmdSubSystem	getCommandSubSystem() Return the command subsystem associated with this command
Object	getContext() Get the current context for this command shell.
IRemoteFileSubSystem	getFileSubSystem() Return the file subsystem associated with this command
String[]	getHistory() Return the list of commands passed into this command
String	getId() Gets the ID of the command shell
int	getIndexOf(Object output) Get the position of this output object in the command container
String	getName() Gets the name of the command shell or command that is being run.
Object	getOutputAt(int index) Get the output object the specified index
int	getSize() Return the number of output objects for this command.
String	getType() Gets the type of the command shell or command that is being run.
boolean	isActive() Indicate whether the corresponding command is running or not
Object[]	listOutput() Get the list of output objects for this command.
void	removeOutput() Remove output from the list of output for this command
void	removeOutput(Object output) Remove output from the list of output for this command
void	updateHistory(String cmd)

Method Detail

getId

public String getId()

Gets the ID of the command shell

Returns:

the id

getName

public String getName()

Gets the name of the command shell or command that is being run.

Returns:

the name of the command

getType

public String getType()

Gets the type of the command shell or command that is being run. The type may either be a "Shell" or a "Command".

Returns:

the type of the command

listOutput

public Object[] listOutput()

Get the list of output objects for this command.

Returns:

the list of output objects

getContext

public Object getContext()

Get the current context for this command shell. In the case of a unix shell, this will be the working directory as an

Returns:

the current context

See Also:

This is used in order to store the state of the current shell on disconnect, such that the same directory can be set on reconnect. It may also be used as input for content assist.

getSize

public int getSize()

Return the number of output objects for this command.

Returns:

the number of output objects

getFileSubSystem

public IRemoteFileSubSystem getFileSubSystem()

Return the file subsystem associated with this command

Returns:

the file subsystem associated with this command

getCommandSubSystem

public IRemoteCmdSubSystem getCommandSubSystem()

Return the command subsystem associated with this command

Returns:

the command subsystem associated with this command

associateProject

public void associateProject(IProject project)

getAssociatedProject

public IProject getAssociatedProject()

addOutput

public void addOutput(Object output)

Add an output object to the list of output for this command

Parameters:

output - the output object to add

removeOutput

public void removeOutput()

Remove output from the list of output for this command

removeOutput

public void removeOutput(Object output)

Remove output from the list of output for this command

getIndexOf

public int getIndexOf(Object output)

Get the position of this output object in the command container

getOutputAt

public Object getOutputAt(int index)

Get the output object the specified index

isActive

public boolean isActive()

Indicate whether the corresponding command is running or not

Returns:

whether the command is running or not

getHistory

public String[] getHistory()

Return the list of commands passed into this command

Returns:

the list of commands issued

updateHistory

public void updateHistory(String cmd)

getCandidateCommands

public ICandidateCommand[] getCandidateCommands()

Return the list of possible commands for this command shell

Returns:

the list of possible commands