org.jline.reader.impl.completer

Class AggregateCompleter

java.lang.Object

org.jline.reader.impl.completer.AggregateCompleter

All Implemented Interfaces:

Completer

public class AggregateCompleter
extends Object
implements Completer

Completer which contains multiple completers and aggregates them together.

Since:

2.3

Author:

Jason Dillon

Constructor Summary

Constructors

Constructor and Description
AggregateCompleter(Collection<Completer> completers) Construct an AggregateCompleter with the given completers.
AggregateCompleter(Completer... completers) Construct an AggregateCompleter with the given completers.

Method Summary

Modifier and Type	Method and Description
void	complete(LineReader reader, ParsedLine line, List<Candidate> candidates) Perform a completion operation across all aggregated completers.
Collection<Completer>	getCompleters() Retrieve the collection of completers currently being aggregated.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AggregateCompleter

public AggregateCompleter(Completer... completers)

Construct an AggregateCompleter with the given completers. The completers will be used in the order given.

Parameters:

completers - the completers

AggregateCompleter

public AggregateCompleter(Collection<Completer> completers)

Construct an AggregateCompleter with the given completers. The completers will be used in the order given.

Parameters:

completers - the completers

Method Detail

getCompleters

public Collection<Completer> getCompleters()

Retrieve the collection of completers currently being aggregated.

Returns:

the aggregated completers

complete

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

Perform a completion operation across all aggregated completers. The effect is similar to the following code:

 completers.forEach(c -> c.complete(reader, line, candidates));

Specified by:

complete in interface Completer

Parameters:

reader - The line reader

line - The parsed command line

candidates - The List of candidates to populate

See Also:

Completer.complete(LineReader, ParsedLine, List)

toString

public String toString()

Overrides:

toString in class Object

Returns:

a string representing the aggregated completers