Class Command
java.lang.Object
de.bsvrz.sys.funclib.losb.util.cmdinterface.Command
- Direct Known Subclasses:
HiddenCommand
Abstrakte Klasse für Kommandos des
CmdInterpreter-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract voidexecute()Methode muss von einer implementierenden Klasse gefüllt werdengetDesc()Beschreibung lesengetHelp()Hilfetext lesenintgetIndex()Index des Kommandos auslesenEltern-Menü für Kommando lesenvoidAusgabe auf Client-Konsole (z.b. via Telnet)voidprintlnPlain(String out) Ausgabe auf Client-Konsole (z.b. via Telnet) ohne die aktuelle Option auszugebenreadln()Benutzereingabe in einem Kommando (Abbruch bei Überschreitung des Server-Timeout)voidBeschreibung setzen (wird im Menü in eckigen Klammern angezeigt)voidHilfetext setzenvoidsetIndex()Index des Kommandos setzen (abhängig vom Eltern-Menü und Geschwister-Einträgen)voidEltern-Menü für Kommando setzenvoidsetStreams(BufferedReader in, BufferedWriter out) Reader und Writer für Ein- und Ausgabefunktionen des Kommandos setzentoString()
-
Constructor Details
-
Command
Kommando fürCmdInterpreter- Parameters:
desc- die Beschreibunghelp- der Hilfetext
-
-
Method Details
-
setStreams
Reader und Writer für Ein- und Ausgabefunktionen des Kommandos setzen- Parameters:
in- Eingabe-Readerout- Ausgabe-Writer
-
getParent
Eltern-Menü für Kommando lesen- Returns:
- Eltern-Menü
-
setParent
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
Hilfetext lesen- Returns:
- der Hilfetext
-
setHelp
Hilfetext setzen- Parameters:
help- Hilfetext
-
getDesc
Beschreibung lesen- Returns:
- die Beschreibung
-
setDesc
Beschreibung setzen (wird im Menü in eckigen Klammern angezeigt)- Parameters:
desc- Beschreibung
-
readln
Benutzereingabe in einem Kommando (Abbruch bei Überschreitung des Server-Timeout)- Returns:
- userinput Benutzereingabe
- Throws:
Exception
-
println
Ausgabe auf Client-Konsole (z.b. via Telnet)- Parameters:
out- der Ausgabe-String- Throws:
Exception
-
printlnPlain
Ausgabe auf Client-Konsole (z.b. via Telnet) ohne die aktuelle Option auszugeben- Parameters:
out- der Ausgabe-String- Throws:
Exception
-
execute
Methode muss von einer implementierenden Klasse gefüllt werden- Throws:
Exception- meist bei Server-Timeout (wird imCmdInterpreterabgefangen)
-
toString
-