Package org.jline.builtins
Class Completers.OptDesc
- java.lang.Object
-
- org.jline.builtins.Completers.OptDesc
-
- Enclosing class:
- Completers
public static class Completers.OptDesc extends java.lang.Object
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.String
description
private java.lang.String
longOption
private java.lang.String
shortOption
private Completer
valueCompleter
-
Constructor Summary
Constructors Modifier Constructor Description protected
OptDesc()
OptDesc(java.lang.String shortOption, java.lang.String longOption)
Command option description.OptDesc(java.lang.String shortOption, java.lang.String longOption, java.lang.String description)
Command option description.OptDesc(java.lang.String shortOption, java.lang.String longOption, java.lang.String description, Completer valueCompleter)
Command option description.OptDesc(java.lang.String shortOption, java.lang.String longOption, Completer valueCompleter)
Command option description.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected static java.util.List<Completers.OptDesc>
compile(java.util.Map<java.lang.String,java.util.List<java.lang.String>> optionValues, java.util.Collection<java.lang.String> options)
protected void
completeOption(LineReader reader, ParsedLine commandLine, java.util.List<Candidate> candidates, boolean longOpt)
protected boolean
completeValue(LineReader reader, ParsedLine commandLine, java.util.List<Candidate> candidates, java.lang.String curBuf, java.lang.String partialValue)
java.lang.String
description()
protected boolean
hasValue()
java.lang.String
longOption()
protected boolean
match(java.lang.String option)
void
setValueCompleter(Completer valueCompleter)
java.lang.String
shortOption()
protected boolean
startsWith(java.lang.String option)
protected Completer
valueCompleter()
-
-
-
Field Detail
-
shortOption
private java.lang.String shortOption
-
longOption
private java.lang.String longOption
-
description
private java.lang.String description
-
valueCompleter
private Completer valueCompleter
-
-
Constructor Detail
-
OptDesc
public OptDesc(java.lang.String shortOption, java.lang.String longOption, java.lang.String description, 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 optionlongOption
- long optiondescription
- short option descriptionvalueCompleter
- option value completer
-
OptDesc
public OptDesc(java.lang.String shortOption, java.lang.String longOption, 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 optionlongOption
- long optionvalueCompleter
- option value completer
-
OptDesc
public OptDesc(java.lang.String shortOption, java.lang.String longOption, java.lang.String description)
Command option description. If option does not have short/long option assign to it null value.- Parameters:
shortOption
- short optionlongOption
- long optiondescription
- short option description
-
OptDesc
public OptDesc(java.lang.String shortOption, java.lang.String longOption)
Command option description. If option does not have short/long option assign to it null value.- Parameters:
shortOption
- short optionlongOption
- long option
-
OptDesc
protected OptDesc()
-
-
Method Detail
-
compile
protected static java.util.List<Completers.OptDesc> compile(java.util.Map<java.lang.String,java.util.List<java.lang.String>> optionValues, java.util.Collection<java.lang.String> options)
-
setValueCompleter
public void setValueCompleter(Completer valueCompleter)
-
longOption
public java.lang.String longOption()
-
shortOption
public java.lang.String shortOption()
-
description
public java.lang.String description()
-
hasValue
protected boolean hasValue()
-
valueCompleter
protected Completer valueCompleter()
-
completeOption
protected void completeOption(LineReader reader, ParsedLine commandLine, java.util.List<Candidate> candidates, boolean longOpt)
-
completeValue
protected boolean completeValue(LineReader reader, ParsedLine commandLine, java.util.List<Candidate> candidates, java.lang.String curBuf, java.lang.String partialValue)
-
match
protected boolean match(java.lang.String option)
-
startsWith
protected boolean startsWith(java.lang.String option)
-
-