StringsCompleter (Apache Karaf :: Shell :: Console 4.3.0-SNAPSHOT API)

java.lang.Object
- jline.console.completer.StringsCompleter

All Implemented Interfaces:

Completer
```
public class StringsCompleter
extends Object
implements Completer
```
Completer for a set of strings.

Since:

2.3

Author:

Jason Dillon

Constructor Summary

Constructors
Constructor Description

StringsCompleter()

StringsCompleter(String... strings)

StringsCompleter(Collection<String> strings)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`complete(String buffer, int cursor, List<CharSequence> candidates)`	Populates candidates with a list of possible completions for the buffer.
`Collection<String>`	`getStrings()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - StringsCompleter
```
public StringsCompleter()
```
  - StringsCompleter
```
public StringsCompleter(Collection<String> strings)
```
  - StringsCompleter
```
public StringsCompleter(String... strings)
```
- Method Detail
  - getStrings
```
public Collection<String> getStrings()
```
  - complete
```
public int complete(String buffer,
                    int cursor,
                    List<CharSequence> candidates)
```
    Description copied from interface: Completer
    
    Populates candidates with a list of possible completions for the buffer. The candidates list will not be sorted before being displayed to the user: thus, the complete method should sort the List before returning.
    
    Specified by:
    
    complete in interface Completer
    
    Parameters:
    
    buffer - The buffer
    
    cursor - The current position of the cursor in the buffer
    
    candidates - The List of candidates to populate
    
    Returns:
    
    The index of the buffer for which the completion will be relative