Module org.jline.builtins

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 Object
implements Completer

Constructor Summary

Constructors

Constructor	Description
OptionCompleter(Collection<Completers.OptDesc> options, int startPos)	OptionCompleter completes command options and parameters.
OptionCompleter(List<Completer> completers, Collection<Completers.OptDesc> options, int startPos)	OptionCompleter completes command options and parameters.
OptionCompleter(List<Completer> completers, Function<String,Collection<Completers.OptDesc>> commandOptions, int startPos)	OptionCompleter completes command options and parameters.
OptionCompleter(List<Completer> completers, Map<String,List<String>> optionValues, Collection<String> options, int startPos)	OptionCompleter completes command options and parameters.
OptionCompleter(Map<String,List<String>> optionValues, Collection<String> options, int startPos)	OptionCompleter completes command options and parameters.
OptionCompleter(Completer completer, Collection<Completers.OptDesc> options, int startPos)	OptionCompleter completes command options and parameters.
OptionCompleter(Completer completer, Function<String,Collection<Completers.OptDesc>> commandOptions, int startPos)	OptionCompleter completes command options and parameters.
OptionCompleter(Completer completer, Map<String,List<String>> optionValues, Collection<String> options, int startPos)	OptionCompleter completes command options and parameters.

Method Summary

Modifier and Type	Method	Description
void	complete(LineReader reader, ParsedLine commandLine, List<Candidate> candidates)
void	setStartPos(int startPos)

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionCompleter

public OptionCompleter(Completer completer,
                       Function<String,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 completer

commandOptions - command options descriptions

startPos - OptionCompleter position in ArgumentCompleter parameters

OptionCompleter

public OptionCompleter(List<Completer> completers,
                       Function<String,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 completers

commandOptions - command options descriptions

startPos - OptionCompleter position in ArgumentCompleter parameters

OptionCompleter

public OptionCompleter(List<Completer> completers,
                       Map<String,List<String>> optionValues,
                       Collection<String> options,
                       int startPos)

OptionCompleter completes command options and parameters. OptionCompleter should be used as an argument of ArgumentCompleter

Parameters:

completers - command parameters completers

optionValues - command value options as map key and its possible values as map value

options - command options that do not have value

startPos - OptionCompleter position in ArgumentCompleter parameters

OptionCompleter

public OptionCompleter(Completer completer,
                       Map<String,List<String>> optionValues,
                       Collection<String> options,
                       int startPos)

OptionCompleter completes command options and parameters. OptionCompleter should be used as an argument of ArgumentCompleter

Parameters:

completer - command parameter completer

optionValues - command value options as map key and its possible values as map value

options - command options that do not have value

startPos - OptionCompleter position in ArgumentCompleter parameters

OptionCompleter

public OptionCompleter(Map<String,List<String>> optionValues,
                       Collection<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 value

options - command options that do not have value

startPos - OptionCompleter position in ArgumentCompleter parameters

OptionCompleter

public OptionCompleter(Completer completer,
                       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 completer

options - command options that do not have value

startPos - OptionCompleter position in ArgumentCompleter parameters

OptionCompleter

public OptionCompleter(List<Completer> completers,
                       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 completers

options - command options that do not have value

startPos - OptionCompleter position in ArgumentCompleter parameters

OptionCompleter

public OptionCompleter(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 value

startPos - OptionCompleter position in ArgumentCompleter parameters

Method Detail

setStartPos

public void setStartPos(int startPos)

complete

public void complete(LineReader reader,
                     ParsedLine commandLine,
                     List<Candidate> candidates)

Specified by:

complete in interface Completer