Class Completers.OptionCompleter

  • All Implemented Interfaces:
    org.jline.reader.Completer
    Enclosing class:
    Completers

    public static class Completers.OptionCompleter
    extends java.lang.Object
    implements org.jline.reader.Completer
    A completer for command options and arguments.

    This completer handles completion for command options (both short and long forms) and their values, as well as command arguments. It's designed to be used as part of an ArgumentCompleter for a complete command-line interface.

    • Constructor Summary

      Constructors 
      Constructor Description
      OptionCompleter​(java.util.Collection<Completers.OptDesc> options, int startPos)
      OptionCompleter completes command options and parameters.
      OptionCompleter​(java.util.List<org.jline.reader.Completer> completers, java.util.Collection<Completers.OptDesc> options, int startPos)
      OptionCompleter completes command options and parameters.
      OptionCompleter​(java.util.List<org.jline.reader.Completer> completers, java.util.function.Function<java.lang.String,​java.util.Collection<Completers.OptDesc>> commandOptions, int startPos)
      OptionCompleter completes command options and parameters.
      OptionCompleter​(java.util.List<org.jline.reader.Completer> completers, java.util.Map<java.lang.String,​java.util.List<java.lang.String>> optionValues, java.util.Collection<java.lang.String> options, int startPos)
      OptionCompleter completes command options and parameters.
      OptionCompleter​(java.util.Map<java.lang.String,​java.util.List<java.lang.String>> optionValues, java.util.Collection<java.lang.String> options, int startPos)
      OptionCompleter completes command options and parameters.
      OptionCompleter​(org.jline.reader.Completer completer, java.util.Collection<Completers.OptDesc> options, int startPos)
      OptionCompleter completes command options and parameters.
      OptionCompleter​(org.jline.reader.Completer completer, java.util.function.Function<java.lang.String,​java.util.Collection<Completers.OptDesc>> commandOptions, int startPos)
      OptionCompleter completes command options and parameters.
      OptionCompleter​(org.jline.reader.Completer completer, java.util.Map<java.lang.String,​java.util.List<java.lang.String>> optionValues, java.util.Collection<java.lang.String> options, int startPos)
      OptionCompleter completes command options and parameters.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void complete​(org.jline.reader.LineReader reader, org.jline.reader.ParsedLine commandLine, java.util.List<org.jline.reader.Candidate> candidates)
      Completes command options and arguments.
      void setStartPos​(int startPos)
      Sets the start position of this completer in the argument list.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • OptionCompleter

        public OptionCompleter​(org.jline.reader.Completer completer,
                               java.util.function.Function<java.lang.String,​java.util.Collection<Completers.OptDesc>> commandOptions,
                               int startPos)
        OptionCompleter completes command options and parameters. OptionCompleter should be used as an argument of ArgumentCompleter
        Parameters:
        completer - command parameter completer
        commandOptions - command options descriptions
        startPos - OptionCompleter position in ArgumentCompleter parameters
      • OptionCompleter

        public OptionCompleter​(java.util.List<org.jline.reader.Completer> completers,
                               java.util.function.Function<java.lang.String,​java.util.Collection<Completers.OptDesc>> commandOptions,
                               int startPos)
        OptionCompleter completes command options and parameters. OptionCompleter should be used as an argument of ArgumentCompleter
        Parameters:
        completers - command parameters completers
        commandOptions - command options descriptions
        startPos - OptionCompleter position in ArgumentCompleter parameters
      • OptionCompleter

        public OptionCompleter​(java.util.List<org.jline.reader.Completer> completers,
                               java.util.Map<java.lang.String,​java.util.List<java.lang.String>> optionValues,
                               java.util.Collection<java.lang.String> options,
                               int startPos)
        OptionCompleter completes command options and parameters. OptionCompleter should be used as an argument of ArgumentCompleter
        Parameters:
        completers - command parameters completers
        optionValues - command value options as map key and its possible values as map value
        options - command options that do not have value
        startPos - OptionCompleter position in ArgumentCompleter parameters
      • OptionCompleter

        public OptionCompleter​(org.jline.reader.Completer completer,
                               java.util.Map<java.lang.String,​java.util.List<java.lang.String>> optionValues,
                               java.util.Collection<java.lang.String> options,
                               int startPos)
        OptionCompleter completes command options and parameters. OptionCompleter should be used as an argument of ArgumentCompleter
        Parameters:
        completer - command parameter completer
        optionValues - command value options as map key and its possible values as map value
        options - command options that do not have value
        startPos - OptionCompleter position in ArgumentCompleter parameters
      • OptionCompleter

        public OptionCompleter​(java.util.Map<java.lang.String,​java.util.List<java.lang.String>> optionValues,
                               java.util.Collection<java.lang.String> options,
                               int startPos)
        OptionCompleter completes command options and parameters. OptionCompleter should be used as an argument of ArgumentCompleter
        Parameters:
        optionValues - command value options as map key and its possible values as map value
        options - command options that do not have value
        startPos - OptionCompleter position in ArgumentCompleter parameters
      • OptionCompleter

        public OptionCompleter​(org.jline.reader.Completer completer,
                               java.util.Collection<Completers.OptDesc> options,
                               int startPos)
        OptionCompleter completes command options and parameters. OptionCompleter should be used as an argument of ArgumentCompleter
        Parameters:
        completer - command parameter completer
        options - command options that do not have value
        startPos - OptionCompleter position in ArgumentCompleter parameters
      • OptionCompleter

        public OptionCompleter​(java.util.List<org.jline.reader.Completer> completers,
                               java.util.Collection<Completers.OptDesc> options,
                               int startPos)
        OptionCompleter completes command options and parameters. OptionCompleter should be used as an argument of ArgumentCompleter
        Parameters:
        completers - command parameters completers
        options - command options that do not have value
        startPos - OptionCompleter position in ArgumentCompleter parameters
      • OptionCompleter

        public OptionCompleter​(java.util.Collection<Completers.OptDesc> options,
                               int startPos)
        OptionCompleter completes command options and parameters. OptionCompleter should be used as an argument of ArgumentCompleter
        Parameters:
        options - command options that do not have value
        startPos - OptionCompleter position in ArgumentCompleter parameters
    • Method Detail

      • setStartPos

        public void setStartPos​(int startPos)
        Sets the start position of this completer in the argument list.
        Parameters:
        startPos - the position of this completer
      • complete

        public void complete​(org.jline.reader.LineReader reader,
                             org.jline.reader.ParsedLine commandLine,
                             java.util.List<org.jline.reader.Candidate> candidates)
        Completes command options and arguments.

        This method handles completion for:

        • Command options (both short and long forms)
        • Option values (for options that take values)
        • Command arguments (using the appropriate argument completer)
        Specified by:
        complete in interface org.jline.reader.Completer
        Parameters:
        reader - the line reader
        commandLine - the parsed command line
        candidates - the list to add completion candidates to