Algernon Software

org.algernon.datatype
Class Command

java.lang.Object
  extended byorg.algernon.datatype.Command

public class Command
extends Object

Command represents a user-level command in Algernon.


Field Summary
private  boolean f_hasSpecialArguments
          This tells the compiler to do something special.
private  boolean f_isObsolete
          This tells the compiler to do something special.
private  boolean f_isPathUnrestricted
          This tells the compiler to do something special.
private  LispValue f_nameSymbol
           
private  String f_obsoleteMessage
          If this command is obsolete, this is the message the user receives.
private  Opcode f_opcode
          This is the opcode corresponding to this comand.
 
Constructor Summary
Command(Algernon algy, LispValue nameSymbol, Opcode opcode, boolean hasSpecialArguments, boolean isPathUnrestricted)
          Creates a new command.
Command(Algernon algy, LispValue nameSymbol, Opcode opcode, boolean hasSpecialArguments, boolean isPathUnrestricted, boolean isObsolete)
          Creates a new command.
 
Method Summary
 LispValue getNameSymbol()
           
 String getObsoleteMessage()
           
 Opcode getOpcode()
           
 boolean hasSpecialArguments()
           
 boolean isObsolete()
           
 boolean isPathUnrestricted()
           
 void setHasSpecialArguments(boolean hasSpecialArguments)
           
 void setIsObsolete(boolean obsolete)
           
 void setIsPathUnrestricted(boolean pathUnrestricted)
           
 void setNameSymbol(LispValue nameSymbol)
           
 void setObsoleteMessage(String message)
           
 void setOpcode(Opcode opcode)
           
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

f_nameSymbol

private LispValue f_nameSymbol

f_hasSpecialArguments

private boolean f_hasSpecialArguments
This tells the compiler to do something special.


f_isObsolete

private boolean f_isObsolete
This tells the compiler to do something special.


f_isPathUnrestricted

private boolean f_isPathUnrestricted
This tells the compiler to do something special.


f_obsoleteMessage

private String f_obsoleteMessage
If this command is obsolete, this is the message the user receives.


f_opcode

private Opcode f_opcode
This is the opcode corresponding to this comand.

Constructor Detail

Command

public Command(Algernon algy,
               LispValue nameSymbol,
               Opcode opcode,
               boolean hasSpecialArguments,
               boolean isPathUnrestricted,
               boolean isObsolete)
Creates a new command. Call this version if the command is obsolete. The other constructor will default to false for the isObsolete argument.


Command

public Command(Algernon algy,
               LispValue nameSymbol,
               Opcode opcode,
               boolean hasSpecialArguments,
               boolean isPathUnrestricted)
Creates a new command. Call this version if the command is not obsolete. Defaults the obsolete argument to false.

Method Detail

hasSpecialArguments

public boolean hasSpecialArguments()

setHasSpecialArguments

public void setHasSpecialArguments(boolean hasSpecialArguments)

isObsolete

public boolean isObsolete()

setIsObsolete

public void setIsObsolete(boolean obsolete)

isPathUnrestricted

public boolean isPathUnrestricted()

setIsPathUnrestricted

public void setIsPathUnrestricted(boolean pathUnrestricted)

getNameSymbol

public LispValue getNameSymbol()

setNameSymbol

public void setNameSymbol(LispValue nameSymbol)

getOpcode

public Opcode getOpcode()

setOpcode

public void setOpcode(Opcode opcode)

setObsoleteMessage

public void setObsoleteMessage(String message)

getObsoleteMessage

public String getObsoleteMessage()

toString

public String toString()

Algernon Software