Package de.svws_nrw.base.shell

Klasse CommandLineParser

java.lang.Object
de.svws_nrw.base.shell.CommandLineParser
public class CommandLineParser extends Object
Diese Klasse dient dem Umgang mit Parametern beim Aufruf von Java-Programmen aus der Kommandozeile.

  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    CommandLineParser(String[] args, @NotNull Logger logger)
    Dieser Konstruktor erzeugt einen neuen Parser für die Kommandozeile.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    void
    addOption(CommandLineOption option)
    Fügt eine neue Option zum Parser hinzu
    String
    getValue(String tag)
    Liefert der Wert der Option mt dem angegebenen short tag.
    String
    getValue(String tag, String def)
    Liefert der Wert der Option mt dem angegebenen short tag oder im Fehlerfall den angegebenen Default-Wert
    boolean
    isSet(String tag)
    Gibt zurück, ob die Option gesetzt wurde oder nicht.
    void
    printOptions(String error)
    Gibt die übergebene Fehlermeldung und die gültigen Kommandozeilen-Optionen über den zugeordneten Logger aus.
    void
    printOptionsAndExit(int code, String error)
    Gibt die übergebene Fehlermeldung und die gültigen Kommandozeilen-Optionen auf der Konsole (System.out) aus und beendet anschließend das Programm mit dem angebeben Exit-Code.

    Von Klasse geerbte Methoden java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Konstruktordetails

    • CommandLineParser

      public CommandLineParser(String[] args, @NotNull @NotNull Logger logger)
      Dieser Konstruktor erzeugt einen neuen Parser für die Kommandozeile.
      Parameter:
      args - die Kommandozeilenparameter
      logger - der Logger für Rückmeldungen des Parsers

  • Methodendetails

    • addOption

      public void addOption(CommandLineOption option) throws CommandLineException
      Fügt eine neue Option zum Parser hinzu
      Parameter:
      option - die hinzuzufügende Option
      Löst aus:
      CommandLineException - tritt auf, falls der short oder long tag der Option bereits zuvor verwendte wurde

    • getValue

      public String getValue(String tag) throws CommandLineException
      Liefert der Wert der Option mt dem angegebenen short tag.
      Parameter:
      tag - das short tag der Option
      Gibt zurück:
      der Wert der Option
      Löst aus:
      CommandLineException - tritt auf, wenn die option nicht bekannt ist oder ein Fehler beim Parsen der Kommandozeile auftritt

    • getValue

      public String getValue(String tag, String def)
      Liefert der Wert der Option mt dem angegebenen short tag oder im Fehlerfall den angegebenen Default-Wert
      Parameter:
      tag - das short tag der Option
      def - der Default-Wert der Option
      Gibt zurück:
      der Wert der Option

    • isSet

      public boolean isSet(String tag)
      Gibt zurück, ob die Option gesetzt wurde oder nicht.
      Parameter:
      tag - das short tag der Option
      Gibt zurück:
      true, falls die Option gesetzt wurde, sonst false

    • printOptions

      public void printOptions(String error)
      Gibt die übergebene Fehlermeldung und die gültigen Kommandozeilen-Optionen über den zugeordneten Logger aus.
      Parameter:
      error - die Fehlermeldung, die ausgegeben werden soll

    • printOptionsAndExit

      public void printOptionsAndExit(int code, String error)
      Gibt die übergebene Fehlermeldung und die gültigen Kommandozeilen-Optionen auf der Konsole (System.out) aus und beendet anschließend das Programm mit dem angebeben Exit-Code.
      Parameter:
      code - die Fehlermeldung, die ausgegeben werden soll
      error - der Exit-Code, mit dem das Programm beendet wird