Enum ReadlineFlag

java.lang.Object

java.lang.Enum<ReadlineFlag>

org.aesh.readline.ReadlineFlag

All Implemented Interfaces:

Serializable, Comparable<ReadlineFlag>, java.lang.constant.Constable

public enum ReadlineFlag
extends Enum<ReadlineFlag>

Enumeration of flags that control readline behavior.

Author:

Ståle W. Pedersen

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
IGNORE_EOF	Ignore EOF signal a given number of times
NO_COMMENT_DISCARD	Do not discard lines starting with '#'
NO_MULTI_LINE_ON_QUOTE	Do not activate multi-line mode 0 = Disable for both single and double quote 1 = Disable for double quote 2 = Disable for single quote
NO_PROMPT_REDRAW_ON_INTR	Do not redraw prompt on INTR signal Default behaviour is to redraw .

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NO_PROMPT_REDRAW_ON_INTR

public static final ReadlineFlag NO_PROMPT_REDRAW_ON_INTR

Do not redraw prompt on INTR signal Default behaviour is to redraw .

IGNORE_EOF

public static final ReadlineFlag IGNORE_EOF

Ignore EOF signal a given number of times

NO_MULTI_LINE_ON_QUOTE

public static final ReadlineFlag NO_MULTI_LINE_ON_QUOTE

Do not activate multi-line mode

• 0 = Disable for both single and double quote
• 1 = Disable for double quote
• 2 = Disable for single quote

NO_COMMENT_DISCARD

public static final ReadlineFlag NO_COMMENT_DISCARD

Do not discard lines starting with '#'

Method Details

values

public static ReadlineFlag[] values()

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

Returns:

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

valueOf

public static ReadlineFlag 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