jline.console.completer
Class NullCompleter

java.lang.Object
  jline.console.completer.NullCompleter

All Implemented Interfaces:

Completer

public final class NullCompleter
extends java.lang.Object
implements Completer

Null completer.

Since:

2.3

Author:

Marc Prud'hommeaux, Jason Dillon

Field Summary

static NullCompleter

INSTANCE

Constructor Summary

NullCompleter()

Method Summary

int	complete(java.lang.String buffer, int cursor, java.util.List<java.lang.CharSequence> 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

Field Detail

INSTANCE

public static final NullCompleter INSTANCE

Constructor Detail

NullCompleter

public NullCompleter()

Method Detail

complete

public int complete(java.lang.String buffer,
                    int cursor,
                    java.util.List<java.lang.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