Class Completers.OptionCompleter

  • All Implemented Interfaces:
    Completer
    Enclosing class:
    Completers

    public static class Completers.OptionCompleter
    extends java.lang.Object
    implements Completer
    • Constructor Summary

      Constructors 
      Constructor Description
      OptionCompleter​(java.util.Collection<Completers.OptDesc> options, int startPos)
      OptionCompleter completes command options and parameters.
      OptionCompleter​(java.util.List<Completer> completers, java.util.Collection<Completers.OptDesc> options, int startPos)
      OptionCompleter completes command options and parameters.
      OptionCompleter​(java.util.List<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<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​(Completer completer, java.util.Collection<Completers.OptDesc> options, int startPos)
      OptionCompleter completes command options and parameters.
      OptionCompleter​(Completer completer, java.util.function.Function<java.lang.String,​java.util.Collection<Completers.OptDesc>> commandOptions, int startPos)
      OptionCompleter completes command options and parameters.
      OptionCompleter​(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​(LineReader reader, ParsedLine commandLine, java.util.List<Candidate> candidates)
      Populates candidates with a list of possible completions for the command line.
      void setStartPos​(int startPos)  
      • Methods inherited from class java.lang.Object

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

      • OptionCompleter

        public OptionCompleter​(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<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<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​(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​(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<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)
      • complete

        public void complete​(LineReader reader,
                             ParsedLine commandLine,
                             java.util.List<Candidate> candidates)
        Description copied from interface: Completer
        Populates candidates with a list of possible completions for the command line. The list of candidates will be sorted and filtered by the LineReader, so that the list of candidates displayed to the user will usually be smaller than the list given by the completer. Thus it is not necessary for the completer to do any matching based on the current buffer. On the contrary, in order for the typo matcher to work, all possible candidates for the word being completed should be returned.
        Specified by:
        complete in interface Completer
        Parameters:
        reader - The line reader
        commandLine - The parsed command line
        candidates - The List of candidates to populate