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)
	OptDesc(String shortOption, String longOption, Completer valueCompleter)
	OptDesc(String shortOption, String longOption, String description)
	OptDesc(String shortOption, String longOption, String description, Completer valueCompleter)

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)
protected 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)

OptDesc

public OptDesc(String shortOption,
               String longOption,
               Completer valueCompleter)

OptDesc

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

OptDesc

public OptDesc(String shortOption,
               String longOption)

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

protected 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)