Class Command
- java.lang.Object
-
- de.bsvrz.sys.funclib.losb.util.cmdinterface.Command
-
- Direct Known Subclasses:
HiddenCommand
public abstract class Command extends java.lang.ObjectAbstrakte Klasse für Kommandos desCmdInterpreter
-
-
Constructor Summary
Constructors Constructor Description Command(java.lang.String desc, java.lang.String help)Kommando fürCmdInterpreter
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract voidexecute()Methode muss von einer implementierenden Klasse gefüllt werdenjava.lang.StringgetDesc()Beschreibung lesenjava.lang.StringgetHelp()Hilfetext lesenintgetIndex()Index des Kommandos auslesenCmdMenugetParent()Eltern-Menü für Kommando lesenvoidprintln(java.lang.String out)Ausgabe auf Client-Konsole (z.b. via Telnet)voidprintlnPlain(java.lang.String out)Ausgabe auf Client-Konsole (z.b. via Telnet) ohne die aktuelle Option auszugebenjava.lang.Stringreadln()Benutzereingabe in einem Kommando (Abbruch bei Überschreitung des Server-Timeout)voidsetDesc(java.lang.String desc)Beschreibung setzen (wird im Menü in eckigen Klammern angezeigt)voidsetHelp(java.lang.String help)Hilfetext setzenvoidsetIndex()Index des Kommandos setzen (abhängig vom Eltern-Menü und Geschwister-Einträgen)voidsetParent(CmdMenu parent)Eltern-Menü für Kommando setzenvoidsetStreams(java.io.BufferedReader in, java.io.BufferedWriter out)Reader und Writer für Ein- und Ausgabefunktionen des Kommandos setzenjava.lang.StringtoString()
-
-
-
Constructor Detail
-
Command
public Command(java.lang.String desc, java.lang.String help)Kommando fürCmdInterpreter- Parameters:
desc- die Beschreibunghelp- der Hilfetext
-
-
Method Detail
-
setStreams
public void setStreams(java.io.BufferedReader in, java.io.BufferedWriter out)Reader und Writer für Ein- und Ausgabefunktionen des Kommandos setzen- Parameters:
in- Eingabe-Readerout- Ausgabe-Writer
-
getParent
public CmdMenu getParent()
Eltern-Menü für Kommando lesen- Returns:
- Eltern-Menü
-
setParent
public void setParent(CmdMenu parent)
Eltern-Menü für Kommando setzen- Parameters:
parent- das Eltern-Menü
-
setIndex
public void setIndex()
Index des Kommandos setzen (abhängig vom Eltern-Menü und Geschwister-Einträgen)
-
getIndex
public int getIndex()
Index des Kommandos auslesen- Returns:
- Index (immer eindeutig in einem Menü)
-
getHelp
public java.lang.String getHelp()
Hilfetext lesen- Returns:
- der Hilfetext
-
setHelp
public void setHelp(java.lang.String help)
Hilfetext setzen- Parameters:
help- Hilfetext
-
getDesc
public java.lang.String getDesc()
Beschreibung lesen- Returns:
- die Beschreibung
-
setDesc
public void setDesc(java.lang.String desc)
Beschreibung setzen (wird im Menü in eckigen Klammern angezeigt)- Parameters:
desc- Beschreibung
-
readln
public java.lang.String readln() throws java.lang.ExceptionBenutzereingabe in einem Kommando (Abbruch bei Überschreitung des Server-Timeout)- Returns:
- userinput Benutzereingabe
- Throws:
java.lang.Exception
-
println
public void println(java.lang.String out) throws java.lang.ExceptionAusgabe auf Client-Konsole (z.b. via Telnet)- Parameters:
out- der Ausgabe-String- Throws:
java.lang.Exception
-
printlnPlain
public void printlnPlain(java.lang.String out) throws java.lang.ExceptionAusgabe auf Client-Konsole (z.b. via Telnet) ohne die aktuelle Option auszugeben- Parameters:
out- der Ausgabe-String- Throws:
java.lang.Exception
-
execute
public abstract void execute() throws java.lang.ExceptionMethode muss von einer implementierenden Klasse gefüllt werden- Throws:
java.lang.Exception- meist bei Server-Timeout (wird imCmdInterpreterabgefangen)
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
-