Package org.jline.reader

Enum LineReader.SuggestionType

java.lang.Object

java.lang.Enum<LineReader.SuggestionType>

org.jline.reader.LineReader.SuggestionType

All Implemented Interfaces:

Serializable, Comparable<LineReader.SuggestionType>

Enclosing interface:

LineReader

public static enum LineReader.SuggestionType
extends Enum<LineReader.SuggestionType>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COMPLETER	Prepare command line suggestions using command completer data.
HISTORY	Prepare command line suggestions using command history.
NONE	As you type command line suggestions are disabled.
TAIL_TIP	Prepare command line suggestions using command completer data and/or command positional argument descriptions.

Method Summary

Modifier and Type	Method	Description
static LineReader.SuggestionType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static LineReader.SuggestionType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final LineReader.SuggestionType NONE

As you type command line suggestions are disabled.

HISTORY

public static final LineReader.SuggestionType HISTORY

Prepare command line suggestions using command history. Requires an additional widgets implementation.

COMPLETER

public static final LineReader.SuggestionType COMPLETER

Prepare command line suggestions using command completer data.

TAIL_TIP

public static final LineReader.SuggestionType TAIL_TIP

Prepare command line suggestions using command completer data and/or command positional argument descriptions. Requires an additional widgets implementation.

Method Detail

values

public static LineReader.SuggestionType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (LineReader.SuggestionType c : LineReader.SuggestionType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static LineReader.SuggestionType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null