java.lang.Object
de.bsvrz.sys.funclib.losb.util.cmdinterface.Command
Direct Known Subclasses:
HiddenCommand

public abstract class Command extends Object
Abstrakte Klasse für Kommandos des CmdInterpreter
  • Constructor Details

    • Command

      public Command(String desc, String help)
      Kommando für CmdInterpreter
      Parameters:
      desc - die Beschreibung
      help - der Hilfetext
  • Method Details

    • setStreams

      public void setStreams(BufferedReader in, BufferedWriter out)
      Reader und Writer für Ein- und Ausgabefunktionen des Kommandos setzen
      Parameters:
      in - Eingabe-Reader
      out - 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 String getHelp()
      Hilfetext lesen
      Returns:
      der Hilfetext
    • setHelp

      public void setHelp(String help)
      Hilfetext setzen
      Parameters:
      help - Hilfetext
    • getDesc

      public String getDesc()
      Beschreibung lesen
      Returns:
      die Beschreibung
    • setDesc

      public void setDesc(String desc)
      Beschreibung setzen (wird im Menü in eckigen Klammern angezeigt)
      Parameters:
      desc - Beschreibung
    • readln

      public String readln() throws Exception
      Benutzereingabe in einem Kommando (Abbruch bei Überschreitung des Server-Timeout)
      Returns:
      userinput Benutzereingabe
      Throws:
      Exception
    • println

      public void println(String out) throws Exception
      Ausgabe auf Client-Konsole (z.b. via Telnet)
      Parameters:
      out - der Ausgabe-String
      Throws:
      Exception
    • printlnPlain

      public void printlnPlain(String out) throws Exception
      Ausgabe auf Client-Konsole (z.b. via Telnet) ohne die aktuelle Option auszugeben
      Parameters:
      out - der Ausgabe-String
      Throws:
      Exception
    • execute

      public abstract void execute() throws Exception
      Methode muss von einer implementierenden Klasse gefüllt werden
      Throws:
      Exception - meist bei Server-Timeout (wird im CmdInterpreter abgefangen)
    • toString

      public String toString()
      Overrides:
      toString in class Object