Module org.jline.terminal

Package org.jline.terminal

Enum Class Attributes.LocalFlag

java.lang.Object

java.lang.Enum<Attributes.LocalFlag>

org.jline.terminal.Attributes.LocalFlag

All Implemented Interfaces:

Serializable, Comparable<Attributes.LocalFlag>, Constable

Enclosing class:

Attributes

public static enum Attributes.LocalFlag
extends Enum<Attributes.LocalFlag>

Local flags that control various terminal behaviors.

Local flags control a variety of terminal behaviors that don't fit into the other flag categories. These include echo control, canonical mode, signal generation, and special character processing.

Common local flags include:

• ECHO - Echo input characters
• ICANON - Enable canonical mode (line-by-line input)
• ISIG - Enable signal generation (INTR, QUIT, SUSP)
• IEXTEN - Enable extended input processing
• ECHOCTL - Echo control characters as ^X

Note: Some flags in this category begin with the letter "I" and might appear to belong in the input flags category, but they are historically part of the local flags.

Local flags can be accessed and modified using methods like Attributes.getLocalFlag(LocalFlag), Attributes.setLocalFlag(LocalFlag, boolean), and Attributes.setLocalFlags(EnumSet).

See Also:

• Attributes.getLocalFlag(LocalFlag)
• Attributes.setLocalFlag(LocalFlag, boolean)
• Attributes.getLocalFlags()
• Attributes.setLocalFlags(EnumSet)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALTWERASE	Use alternate WERASE algorithm
ECHO	Enable echoing
ECHOCTL	Echo control chars as ^(Char)
ECHOE	Visually erase chars
ECHOK	Echo NL after line kill
ECHOKE	Visual erase for line kill
ECHONL	Echo NL even if ECHO is off
ECHOPRT	Visual erase mode for hardcopy
EXTPROC	External processing
FLUSHO	Output being flushed (state)
ICANON	Canonicalize input lines
IEXTEN	Enable DISCARD and LNEXT
ISIG	Enable signals INTR, QUIT, [D]SUSP
NOFLSH	Don't flush after interrupt
NOKERNINFO	No kernel output from VSTATUS
PENDIN	Retype pending input (state)
TOSTOP	Stop background jobs from output
XCASE	Canonical upper/lower presentation (Linux/Solaris)

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ECHOKE

public static final Attributes.LocalFlag ECHOKE

Visual erase for line kill

ECHOE

public static final Attributes.LocalFlag ECHOE

Visually erase chars

ECHOK

public static final Attributes.LocalFlag ECHOK

Echo NL after line kill

ECHO

public static final Attributes.LocalFlag ECHO

Enable echoing

ECHONL

public static final Attributes.LocalFlag ECHONL

Echo NL even if ECHO is off

ECHOPRT

public static final Attributes.LocalFlag ECHOPRT

Visual erase mode for hardcopy

ECHOCTL

public static final Attributes.LocalFlag ECHOCTL

Echo control chars as ^(Char)

ISIG

public static final Attributes.LocalFlag ISIG

Enable signals INTR, QUIT, [D]SUSP

ICANON

public static final Attributes.LocalFlag ICANON

Canonicalize input lines

XCASE

public static final Attributes.LocalFlag XCASE

Canonical upper/lower presentation (Linux/Solaris)

ALTWERASE

public static final Attributes.LocalFlag ALTWERASE

Use alternate WERASE algorithm

IEXTEN

public static final Attributes.LocalFlag IEXTEN

Enable DISCARD and LNEXT

EXTPROC

public static final Attributes.LocalFlag EXTPROC

External processing

TOSTOP

public static final Attributes.LocalFlag TOSTOP

Stop background jobs from output

FLUSHO

public static final Attributes.LocalFlag FLUSHO

Output being flushed (state)

NOKERNINFO

public static final Attributes.LocalFlag NOKERNINFO

No kernel output from VSTATUS

PENDIN

public static final Attributes.LocalFlag PENDIN

Retype pending input (state)

NOFLSH

public static final Attributes.LocalFlag NOFLSH

Don't flush after interrupt

Method Details

values

public static Attributes.LocalFlag[] values()

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

Returns:

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

valueOf

public static Attributes.LocalFlag valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null