Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 

RSE
Release 3.0

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

All Known Subinterfaces:
IServiceCommandShell
All Known Implementing Classes:
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.
  String getContextString ()
          Get the current context for this command shell as a string.
  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

String getId()
Gets the ID of the command shell

Returns:
the id

getName

String getName()
Gets the name of the command shell or command that is being run.

Returns:
the name of the command

getType

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

Object[] listOutput()
Get the list of output objects for this command.

Returns:
the list of output objects

getContext

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

getContextString

String getContextString()
Get the current context for this command shell as a string. Unlike getContext(), this method simply returns a string representation of the context (so that no query is required to get the working directory).

Returns:
the context as a string

getSize

int getSize()
Return the number of output objects for this command.

Returns:
the number of output objects

getFileSubSystem

IRemoteFileSubSystem getFileSubSystem()
Return the file subsystem associated with this command

Returns:
the file subsystem associated with this command

getCommandSubSystem

IRemoteCmdSubSystem getCommandSubSystem()
Return the command subsystem associated with this command

Returns:
the command subsystem associated with this command

associateProject

void associateProject(
IProject project)

getAssociatedProject

IProject getAssociatedProject()

addOutput

void addOutput(
Object output)
Add an output object to the list of output for this command

Parameters:
output - the output object to add

removeOutput

void removeOutput()
Remove output from the list of output for this command


removeOutput

void removeOutput(
Object output)
Remove output from the list of output for this command


getIndexOf

int getIndexOf(
Object output)
Get the position of this output object in the command container


getOutputAt

Object getOutputAt(int index)
Get the output object the specified index


isActive

boolean isActive()
Indicate whether the corresponding command is running or not

Returns:
whether the command is running or not

getHistory

String[] getHistory()
Return the list of commands passed into this command

Returns:
the list of commands issued

updateHistory

void updateHistory(
String cmd)

getCandidateCommands

ICandidateCommand[] getCandidateCommands()
Return the list of possible commands for this command shell

Returns:
the list of possible commands

RSE
Release 3.0

Copyright (c) IBM Corporation and others 2000, 2008. All Rights Reserved.

 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire