Package com.pnfsoftware.jeb.util.interpreter

Class AutocompletionResult

java.lang.Object

com.pnfsoftware.jeb.util.interpreter.AutocompletionResult

public class AutocompletionResult
extends Object

An object representing the result of an autocompletion request.

Field Summary

Fields

Modifier and Type	Field	Description
static final AutocompletionResult	EMPTY	Empty auto-completion result.

Constructor Summary

Constructors

Constructor	Description
AutocompletionResult()	Create an empty auto-completion result using a space separator.
AutocompletionResult(char lastSeparator)	Create an empty auto-completion result.
AutocompletionResult(List<String> autocompletes)	Create an auto-completion result using a space separator.
AutocompletionResult(List<String> autocompletes, char lastSeparator)	Create an auto-completion result.

Method Summary

Modifier and Type	Method	Description
boolean	add(String entry)	Add a completion entry.
void	addAll(Collection<String> entries)	Add completion entries.
static List<String>	filterStartsWith(String text, List<String> toks)	Filter tokens by prefix.
List<String>	getAutocompletes()	Get completion entries.
char	getLastSeparator()	The last separator before the token being completed.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

EMPTY

public static final AutocompletionResult EMPTY

Empty auto-completion result.

Constructor Details

AutocompletionResult

public AutocompletionResult()

Create an empty auto-completion result using a space separator.

AutocompletionResult

public AutocompletionResult(List<String> autocompletes)

Create an auto-completion result using a space separator.

Parameters:

autocompletes - completion entries

AutocompletionResult

public AutocompletionResult(char lastSeparator)

Create an empty auto-completion result.

Parameters:

lastSeparator - separator that precedes the token being completed

AutocompletionResult

public AutocompletionResult(List<String> autocompletes,
 char lastSeparator)

Create an auto-completion result.

Parameters:

autocompletes - completion entries

lastSeparator - separator that precedes the token being completed

Method Details

add

public boolean add(String entry)

Add a completion entry.

Parameters:

entry - completion entry

Returns:

true if the entry was added

addAll

public void addAll(Collection<String> entries)

Add completion entries.

Parameters:

entries - completion entries

getAutocompletes

public List<String> getAutocompletes()

Get completion entries.

Returns:

mutable list of completion entries

getLastSeparator

public char getLastSeparator()

The last separator before the token being completed. For example, when "this.foo.b" is typed, the completion applies to "b" and the last separator is ".". The default separator is a single space.

Returns:

the last separator character

toString

public String toString()

Overrides:

toString in class Object

filterStartsWith

public static List<String> filterStartsWith(String text,
 List<String> toks)

Filter tokens by prefix.

Parameters:

text - required token prefix

toks - candidate tokens

Returns:

tokens starting with text