com.sshtools.server.vshell.terminal

Class CommandArgsCompletor

java.lang.Object

com.sshtools.server.vshell.terminal.CommandArgsCompletor

All Implemented Interfaces:

Completor

public class CommandArgsCompletor
extends Object
implements Completor

Constructor Summary

Constructors

Constructor and Description
CommandArgsCompletor(VirtualProcess process)

Method Summary

Modifier and Type	Method and Description
int	complete(String buffer, int cursor, List<String> candidates) Populates candidates with a list of possible completions for the buffer.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandArgsCompletor

public CommandArgsCompletor(VirtualProcess process)

Method Detail

complete

public int complete(String buffer,
                    int cursor,
                    List<String> candidates)

Description copied from interface: Completor

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 Completor

Parameters:

buffer - the buffer

candidates - the List of candidates to populate

Returns:

the index of the buffer for which the completion will be relative