c408h006
Class Command

java.lang.Object
  extended byc408h006.Command

public class Command
extends java.lang.Object

A command sent to modify a file within the OmniEdtior system.


Constructor Summary
Command()
          Default constructor.
Command(int id, java.lang.String fileName, java.lang.String command, int pos, java.lang.String file)
          Constructs an instance of this class.
 
Method Summary
 java.lang.String getCommand()
          Returns the name of the command to be performed on the file.
 java.lang.String getFile()
          Returns the file associated with the command being sent.
 java.lang.String getFileName()
          Returns the name of the file the command is being sent to.
 int getID()
          Returns the ID of the User sending the command.
 int getPosition()
          Returns a position within the file relating to the command being sent.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Command

public Command()
Default constructor.


Command

public Command(int id,
               java.lang.String fileName,
               java.lang.String command,
               int pos,
               java.lang.String file)
Constructs an instance of this class.

Parameters:
id - The ID of the User sending the command
fileName - The name of the file to be modified
command - The name of the command to be performed on the file
pos - A position within the file relating to the command being sent
file - A file to be sent to the OmniEditor system (in most cases only set when calling the "download" command)
Method Detail

getID

public int getID()
Returns the ID of the User sending the command.

Returns:
The ID of the User sending the command.

getFileName

public java.lang.String getFileName()
Returns the name of the file the command is being sent to.

Returns:
The name of the file the command is being sent to

getCommand

public java.lang.String getCommand()
Returns the name of the command to be performed on the file.

Returns:
The name of the command being sent to the file

getPosition

public int getPosition()
Returns a position within the file relating to the command being sent.

Returns:
A position within the file relating to the command being sent

getFile

public java.lang.String getFile()
Returns the file associated with the command being sent.

Returns:
The file associated with the command being sent