org.jline.builtins

Class Completers.OptDesc

java.lang.Object

org.jline.builtins.Completers.OptDesc

Enclosing class:

Completers

public static class Completers.OptDesc
extends Object

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OptDesc()
	OptDesc(String shortOption, String longOption) Command option description.
	OptDesc(String shortOption, String longOption, Completer valueCompleter) Command option description.
	OptDesc(String shortOption, String longOption, String description) Command option description.
	OptDesc(String shortOption, String longOption, String description, Completer valueCompleter) Command option description.

Method Summary

Modifier and Type	Method and Description
protected static List<Completers.OptDesc>	compile(Map<String,List<String>> optionValues, Collection<String> options)
protected void	completeOption(LineReader reader, ParsedLine commandLine, List<Candidate> candidates, boolean longOpt)
protected boolean	completeValue(LineReader reader, ParsedLine commandLine, List<Candidate> candidates, String curBuf, String partialValue)
String	description()
protected boolean	hasValue()
String	longOption()
protected boolean	match(String option)
void	setValueCompleter(Completer valueCompleter)
String	shortOption()
protected boolean	startsWith(String option)
protected Completer	valueCompleter()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OptDesc

public OptDesc(String shortOption,
               String longOption,
               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 option

longOption - long option

description - short option description

valueCompleter - option value completer

OptDesc

public OptDesc(String shortOption,
               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 option

longOption - long option

valueCompleter - option value completer

OptDesc

public OptDesc(String shortOption,
               String longOption,
               String description)

Command option description. If option does not have short/long option assign to it null value.

Parameters:

shortOption - short option

longOption - long option

description - short option description

OptDesc

public OptDesc(String shortOption,
               String longOption)

Command option description. If option does not have short/long option assign to it null value.

Parameters:

shortOption - short option

longOption - long option

OptDesc

protected OptDesc()

Method Detail

compile

protected static List<Completers.OptDesc> compile(Map<String,List<String>> optionValues,
                                                  Collection<String> options)

setValueCompleter

public void setValueCompleter(Completer valueCompleter)

longOption

public String longOption()

shortOption

public String shortOption()

description

public String description()

hasValue

protected boolean hasValue()

valueCompleter

protected Completer valueCompleter()

completeOption

protected void completeOption(LineReader reader,
                              ParsedLine commandLine,
                              List<Candidate> candidates,
                              boolean longOpt)

completeValue

protected boolean completeValue(LineReader reader,
                                ParsedLine commandLine,
                                List<Candidate> candidates,
                                String curBuf,
                                String partialValue)

match

protected boolean match(String option)

startsWith

protected boolean startsWith(String option)