org.lsst.ccs.command

Class DictionaryCompleter

java.lang.Object

org.lsst.ccs.command.DictionaryCompleter

public class DictionaryCompleter
extends Object

Performs command completion, based on the information available in the command dictionary. This is designed to be jline compatible, but not actually implement jline's command completer to avoid adding a permanent dependency on jline.

Author:

tonyj

Constructor Summary

Constructors

Constructor and Description
DictionaryCompleter(Dictionary dict) Create a command completer for the given dictionary.

Method Summary

Methods

Modifier and Type	Method and Description
int	complete(String buffer, int index, List<CharSequence> list) Generate a list of possible command completions.

Methods inherited from class java.lang.Object

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

Constructor Detail

DictionaryCompleter

public DictionaryCompleter(Dictionary dict)

Create a command completer for the given dictionary.

Parameters:

dict -

Method Detail

complete

public int complete(String buffer,
           int index,
           List<CharSequence> list)

Generate a list of possible command completions. This method is copied from JLine but seems to have a number of short-comings, in particular the return value seems to only be used if a single item is put into the list, and thus used automatically for completion. It also gives no way to do more than just present a list of choices, for example if the cursor is positioned on an argument we might want to give the user the description of the parameter, rather than just a list of choices.

Parameters:

buffer - The current content of the input line

index - The index within the input line of the cursor

list - A list which this routine should fill with possible command completions.

Returns:

The position at which the cursor should be positioned prior to adding any of the returned items to the buffer.