|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.pz.platypus.Command
public abstract class Command
The basic abstract class for all commands
Field Summary | |
---|---|
protected ParamType |
parameterType
what kind of parameter does this command take, if any? |
protected java.lang.String |
root
the command root |
protected java.lang.String |
rootSubstitute
the substitute root, if this command is shorthand for another |
protected boolean |
validInCode
is this command executed in a listing or code section? |
Constructor Summary | |
---|---|
Command()
|
Method Summary | |
---|---|
ParamType |
getParamType()
what kind of argument, if any, does the command take? |
java.lang.String |
getRoot()
get the root of the command. |
java.lang.String |
getRootSubstitute()
get a substitute string for the root. |
boolean |
isAllowedInCode()
Is this command processed or ignored in a code listing? |
int |
notExecutedInCodeSection(java.lang.String command,
TokenList tl,
Source source,
GDD gdd)
Handles the situation in which a command that is not supported in a listing or code section is encountered while in one. |
int |
process(char[] input,
int parsePoint,
TokenList tl,
boolean inCode,
Source source,
GDD gdd)
method for processing this command. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.pz.platypus.interfaces.ICommand |
---|
process |
Field Detail |
---|
protected ParamType parameterType
protected java.lang.String root
protected java.lang.String rootSubstitute
protected boolean validInCode
Constructor Detail |
---|
public Command()
Method Detail |
---|
public java.lang.String getRoot()
getRoot
in interface ICommand
public java.lang.String getRootSubstitute()
getRootSubstitute
in interface ICommand
public ParamType getParamType()
getParamType
in interface ICommand
public boolean isAllowedInCode()
isAllowedInCode
in interface ICommand
public int process(char[] input, int parsePoint, TokenList tl, boolean inCode, Source source, GDD gdd)
input
- the input chars (fron the Platypus file)parsePoint
- the point in the input where the command beginstl
- TokenList to which the generated tokens are addedinCode
- Are we currently in a code section?source
- the file# and line# of the current inputgdd
- the GDD
public int notExecutedInCodeSection(java.lang.String command, TokenList tl, Source source, GDD gdd)
tl
- TokenList being created by the parsersource
- the current file# and line#gdd
- Global Document Datacommand
- the command string as it appeared in the input text
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |