Package org.jline.builtins
Class Completers.OptionCompleter
- java.lang.Object
-
- org.jline.builtins.Completers.OptionCompleter
-
- All Implemented Interfaces:
Completer
- Enclosing class:
- Completers
public static class Completers.OptionCompleter extends java.lang.Object implements Completer
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.List<Completer>
argsCompleters
private java.util.function.Function<java.lang.String,java.util.Collection<Completers.OptDesc>>
commandOptions
private java.util.Collection<Completers.OptDesc>
options
private int
startPos
-
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.private Completers.OptDesc
findOptDesc(java.lang.String command, java.lang.String opt)
private Completers.OptDesc
findOptDesc(java.util.Collection<Completers.OptDesc> optDescs, java.lang.String opt)
private Completer
longOptionValueCompleter(java.lang.String command, java.lang.String opt)
void
setStartPos(int startPos)
private Completer
shortOptionValueCompleter(java.lang.String command, java.lang.String opt)
-
-
-
Field Detail
-
commandOptions
private java.util.function.Function<java.lang.String,java.util.Collection<Completers.OptDesc>> commandOptions
-
options
private java.util.Collection<Completers.OptDesc> options
-
argsCompleters
private java.util.List<Completer> argsCompleters
-
startPos
private int startPos
-
-
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 completercommandOptions
- command options descriptionsstartPos
- 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 completerscommandOptions
- command options descriptionsstartPos
- 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 completersoptionValues
- command value options as map key and its possible values as map valueoptions
- command options that do not have valuestartPos
- 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 completeroptionValues
- command value options as map key and its possible values as map valueoptions
- command options that do not have valuestartPos
- 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 valueoptions
- command options that do not have valuestartPos
- 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 completeroptions
- command options that do not have valuestartPos
- 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 completersoptions
- command options that do not have valuestartPos
- 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 valuestartPos
- 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.
-
longOptionValueCompleter
private Completer longOptionValueCompleter(java.lang.String command, java.lang.String opt)
-
shortOptionValueCompleter
private Completer shortOptionValueCompleter(java.lang.String command, java.lang.String opt)
-
findOptDesc
private Completers.OptDesc findOptDesc(java.lang.String command, java.lang.String opt)
-
findOptDesc
private Completers.OptDesc findOptDesc(java.util.Collection<Completers.OptDesc> optDescs, java.lang.String opt)
-
-