Class Completers.RegexCompleter

  • All Implemented Interfaces:
    Completer
    Enclosing class:
    Completers

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

      Constructors 
      Constructor Description
      RegexCompleter​(java.lang.String syntax, java.util.function.Function<java.lang.String,​Completer> completers)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void complete​(LineReader reader, ParsedLine line, java.util.List<Candidate> candidates)
      Populates candidates with a list of possible completions for the command line.
      private boolean doMatch​(java.lang.String arg, java.lang.String name)  
      • Methods inherited from class java.lang.Object

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

      • matcher

        private final NfaMatcher<java.lang.String> matcher
      • completers

        private final java.util.function.Function<java.lang.String,​Completer> completers
      • reader

        private final java.lang.ThreadLocal<LineReader> reader
    • Constructor Detail

      • RegexCompleter

        public RegexCompleter​(java.lang.String syntax,
                              java.util.function.Function<java.lang.String,​Completer> completers)
    • Method Detail

      • complete

        public void complete​(LineReader reader,
                             ParsedLine line,
                             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
        line - The parsed command line
        candidates - The List of candidates to populate
      • doMatch

        private boolean doMatch​(java.lang.String arg,
                                java.lang.String name)