Module org.jline.builtins
Package org.jline.builtins

Class Completers.OptDesc

java.lang.Object
org.jline.builtins.Completers.OptDesc
Enclosing class:
Completers
public static class Completers.OptDesc extends Object

  • Constructor Details

    • OptDesc

      public OptDesc(String shortOption, String longOption, String description, org.jline.reader.Completer valueCompleter)
      Command option description. If option does not have short/long option assign to it null value. If option does not have value set valueCompleter = NullCompleter.INSTANCE
      Parameters:
      shortOption - short option
      longOption - long option
      description - short option description
      valueCompleter - option value completer

    • OptDesc

      public OptDesc(String shortOption, String longOption, org.jline.reader.Completer valueCompleter)
      Command option description. If option does not have short/long option assign to it null value. If option does not have value set valueCompleter = NullCompleter.INSTANCE
      Parameters:
      shortOption - short option
      longOption - long option
      valueCompleter - option value completer

    • OptDesc

      public OptDesc(String shortOption, String longOption, String description)
      Command option description. If option does not have short/long option assign to it null value.
      Parameters:
      shortOption - short option
      longOption - long option
      description - short option description

    • OptDesc

      public OptDesc(String shortOption, String longOption)
      Command option description. If option does not have short/long option assign to it null value.
      Parameters:
      shortOption - short option
      longOption - long option

    • OptDesc

      protected OptDesc()

  • Method Details

    • compile

      protected static List<Completers.OptDesc> compile(Map<String,List<String>> optionValues, Collection<String> options)

    • setValueCompleter

      public void setValueCompleter(org.jline.reader.Completer valueCompleter)

    • longOption

      public String longOption()

    • shortOption

      public String shortOption()

    • description

      public String description()

    • hasValue

      protected boolean hasValue()

    • valueCompleter

      protected org.jline.reader.Completer valueCompleter()

    • completeOption

      protected void completeOption(org.jline.reader.LineReader reader, org.jline.reader.ParsedLine commandLine, List<org.jline.reader.Candidate> candidates, boolean longOpt)

    • completeValue

      protected boolean completeValue(org.jline.reader.LineReader reader, org.jline.reader.ParsedLine commandLine, List<org.jline.reader.Candidate> candidates, String curBuf, String partialValue)

    • match

      protected boolean match(String option)

    • startsWith

      protected boolean startsWith(String option)