Modifier and Type	Class and Description
public static class	ArgumentCompleter.ArgumentLine

Modifier and Type	Field and Description
private final List<Completer>	completers
private boolean	strict
private boolean	strictCommand

Access	Constructor and Description
public	ArgumentCompleter(final Collection<Completer> The embedded completers completers) Create a new completer.
public	ArgumentCompleter(final Completer... The embedded completers completers) Create a new completer.

Method Summary

Modifier and Type	Method and Description
public void	complete(LineReader reader, ParsedLine line, final List<Candidate> candidates) Implements jdk.internal.org.jline.reader.Completer.complete. Populates candidates with a list of possible completions for the command line.
public List<Completer>	Returns: The list of completers. getCompleters() Returns the list of completers used inside this `ArgumentCompleter`.
public boolean	Returns: True if strict. isStrict() Returns whether a completion at argument index N will success if all the completions from arguments 0-(N-1) also succeed.
public void	setStrict(final boolean the strict flag strict) If true, a completion at argument index N will only succeed if all the completions from 0-(N-1) also succeed.
public void	setStrictCommand(final boolean the strictCommand flag strictCommand) If true, a completion at argument index N will only succeed if all the completions from 1-(N-1) also succeed.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

completers	back to summary
private final List<Completer> completers

strict	back to summary
private boolean strict

strictCommand	back to summary
private boolean strictCommand

Constructor Detail

ArgumentCompleter	back to summary
public ArgumentCompleter(final Collection<Completer> completers) Create a new completer. Parameters completers:Collection<Completer> The embedded completers

ArgumentCompleter

back to summary

public ArgumentCompleter(final Collection<Completer> completers)

Create a new completer.

Parameters

completers:Collection<Completer>: The embedded completers

ArgumentCompleter	back to summary
public ArgumentCompleter(final Completer... completers) Create a new completer. Parameters completers:Completer[] The embedded completers

ArgumentCompleter

back to summary

public ArgumentCompleter(final Completer... completers)

Create a new completer.

Parameters

completers:Completer[]: The embedded completers

Method Detail

complete	back to summary
public void complete(LineReader reader, ParsedLine line, final List<Candidate> candidates) Implements jdk.internal.org.jline.reader.Completer.complete. Doc from jdk.internal.org.jline.reader.Completer.complete. 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.

complete

back to summary

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

Implements jdk.internal.org.jline.reader.Completer.complete.

Doc from jdk.internal.org.jline.reader.Completer.complete.

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.

getCompleters back to summary

getCompleters	back to summary
public List<Completer> getCompleters() Returns the list of completers used inside this `ArgumentCompleter`. Returns:List<Completer> The list of completers. Since 2.3

public List<Completer> getCompleters()

Returns the list of completers used inside this ArgumentCompleter.

Returns:List<Completer>: The list of completers.
Since: 2.3

isStrict	back to summary
public boolean isStrict() Returns whether a completion at argument index N will success if all the completions from arguments 0-(N-1) also succeed. Returns:boolean True if strict. Since 2.3

isStrict

back to summary

public boolean isStrict()

Returns whether a completion at argument index N will success if all the completions from arguments 0-(N-1) also succeed.

Returns:boolean: True if strict.
Since: 2.3

setStrict	back to summary
public void setStrict(final boolean strict) If true, a completion at argument index N will only succeed if all the completions from 0-(N-1) also succeed. Parameters strict:boolean the strict flag

setStrict

back to summary

public void setStrict(final boolean strict)

If true, a completion at argument index N will only succeed if all the completions from 0-(N-1) also succeed.

Parameters

strict:boolean: the strict flag

setStrictCommand	back to summary
public void setStrictCommand(final boolean strictCommand) If true, a completion at argument index N will only succeed if all the completions from 1-(N-1) also succeed. Parameters strictCommand:boolean the strictCommand flag

setStrictCommand

back to summary

public void setStrictCommand(final boolean strictCommand)

If true, a completion at argument index N will only succeed if all the completions from 1-(N-1) also succeed.

Parameters

strictCommand:boolean: the strictCommand flag

jdk.internal.org.jline.reader.impl.completer back to summary

public Class ArgumentCompleter.ArgumentLine

Class Inheritance

extends Object
implements ParsedLine

java.lang.Object
jdk.internal.org.jline.reader.impl.completer.ArgumentCompleter.ArgumentLine

All Implemented Interfaces

jdk.internal.org.jline.reader.ParsedLine

Field Summary

Modifier and Type	Field and Description
private final int	cursor
private final String	word

Constructor Summary

Access	Constructor and Description
public	ArgumentLine(String word, int cursor)

Method Summary

Modifier and Type	Method and Description
public int	cursor() Implements jdk.internal.org.jline.reader.ParsedLine.cursor. The cursor position within the line.
public String	line() Implements jdk.internal.org.jline.reader.ParsedLine.line. The unparsed line.
public String	word() Implements jdk.internal.org.jline.reader.ParsedLine.word. The current word being completed.
public int	wordCursor() Implements jdk.internal.org.jline.reader.ParsedLine.wordCursor. The cursor position within the current word.
public int	wordIndex() Implements jdk.internal.org.jline.reader.ParsedLine.wordIndex. The index of the current word in the list of words.
public List<String>	words() Implements jdk.internal.org.jline.reader.ParsedLine.words. The list of words.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

cursor	back to summary
private final int cursor

word	back to summary
private final String word

Constructor Detail

ArgumentLine	back to summary
public ArgumentLine(String word, int cursor)

Method Detail

cursor	back to summary
public int cursor() Implements jdk.internal.org.jline.reader.ParsedLine.cursor. Doc from jdk.internal.org.jline.reader.ParsedLine.cursor. The cursor position within the line. Annotations @Override

cursor

back to summary

public int cursor()

Implements jdk.internal.org.jline.reader.ParsedLine.cursor.

Doc from jdk.internal.org.jline.reader.ParsedLine.cursor.

The cursor position within the line.

Annotations

@Override

line	back to summary
public String line() Implements jdk.internal.org.jline.reader.ParsedLine.line. Doc from jdk.internal.org.jline.reader.ParsedLine.line. The unparsed line. Annotations @Override

line

back to summary

public String line()

Implements jdk.internal.org.jline.reader.ParsedLine.line.

Doc from jdk.internal.org.jline.reader.ParsedLine.line.

The unparsed line.

Annotations

@Override

word	back to summary
public String word() Implements jdk.internal.org.jline.reader.ParsedLine.word. Doc from jdk.internal.org.jline.reader.ParsedLine.word. The current word being completed. If the cursor is after the last word, an empty string is returned. Annotations @Override

word

back to summary

public String word()

Implements jdk.internal.org.jline.reader.ParsedLine.word.

Doc from jdk.internal.org.jline.reader.ParsedLine.word.

The current word being completed. If the cursor is after the last word, an empty string is returned.

Annotations

@Override

wordCursor	back to summary
public int wordCursor() Implements jdk.internal.org.jline.reader.ParsedLine.wordCursor. Doc from jdk.internal.org.jline.reader.ParsedLine.wordCursor. The cursor position within the current word. Annotations @Override

wordCursor

back to summary

public int wordCursor()

Implements jdk.internal.org.jline.reader.ParsedLine.wordCursor.

Doc from jdk.internal.org.jline.reader.ParsedLine.wordCursor.

The cursor position within the current word.

Annotations

@Override

wordIndex	back to summary
public int wordIndex() Implements jdk.internal.org.jline.reader.ParsedLine.wordIndex. Doc from jdk.internal.org.jline.reader.ParsedLine.wordIndex. The index of the current word in the list of words. Annotations @Override

wordIndex

back to summary

public int wordIndex()

Implements jdk.internal.org.jline.reader.ParsedLine.wordIndex.

Doc from jdk.internal.org.jline.reader.ParsedLine.wordIndex.

The index of the current word in the list of words.

Annotations

@Override

words	back to summary
public List<String> words() Implements jdk.internal.org.jline.reader.ParsedLine.words. Doc from jdk.internal.org.jline.reader.ParsedLine.words. The list of words. Annotations @Override

words

back to summary

public List<String> words()

Implements jdk.internal.org.jline.reader.ParsedLine.words.

Doc from jdk.internal.org.jline.reader.ParsedLine.words.

The list of words.

Annotations