Package org.jline.terminal

Enum Class Attributes.ControlChar

java.lang.Object

java.lang.Enum<Attributes.ControlChar>

org.jline.terminal.Attributes.ControlChar

All Implemented Interfaces:

Serializable, Comparable<Attributes.ControlChar>, Constable

Enclosing class:

Attributes

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

Control characters used for special terminal functions.

Control characters are special characters that trigger specific terminal behaviors when encountered in the input stream. These characters control various aspects of terminal operation, such as signaling end-of-file, interrupting processes, or erasing characters.

The most commonly used control characters include:

• VEOF - End-of-file character (typically Ctrl+D)
• VINTR - Interrupt character (typically Ctrl+C)
• VQUIT - Quit character (typically Ctrl+\)
• VERASE - Erase character (typically Backspace)
• VKILL - Kill line character (typically Ctrl+U)
• VMIN - Minimum number of characters for non-canonical read
• VTIME - Timeout in deciseconds for non-canonical read

Control characters can be accessed and modified using Attributes.getControlChar(ControlChar) and Attributes.setControlChar(ControlChar, int).

See Also:

• Attributes.getControlChar(ControlChar)
• Attributes.setControlChar(ControlChar, int)

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
VDISCARD	Discard output character (typically Ctrl+O)
VDSUSP	Delayed suspend character
VEOF	End-of-file character (typically Ctrl+D)
VEOL	End-of-line character
VEOL2	Secondary end-of-line character
VERASE	Erase character (typically Backspace)
VINTR	Interrupt character (typically Ctrl+C)
VKILL	Kill line character (typically Ctrl+U)
VLNEXT	Literal next character (typically Ctrl+V)
VMIN	Minimum number of characters for non-canonical read
VQUIT	Quit character (typically Ctrl+\)
VREPRINT	Reprint line character (typically Ctrl+R)
VSTART	Start output character (typically Ctrl+Q)
VSTATUS	Status request character (typically Ctrl+T)
VSTOP	Stop output character (typically Ctrl+S)
VSUSP	Suspend character (typically Ctrl+Z)
VTIME	Timeout in deciseconds for non-canonical read
VWERASE	Word erase character (typically Ctrl+W)

Method Summary

Modifier and Type	Method	Description
static Attributes.ControlChar	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Attributes.ControlChar[]	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

VEOF

public static final Attributes.ControlChar VEOF

End-of-file character (typically Ctrl+D)

VEOL

public static final Attributes.ControlChar VEOL

End-of-line character

VEOL2

public static final Attributes.ControlChar VEOL2

Secondary end-of-line character

VERASE

public static final Attributes.ControlChar VERASE

Erase character (typically Backspace)

VWERASE

public static final Attributes.ControlChar VWERASE

Word erase character (typically Ctrl+W)

VKILL

public static final Attributes.ControlChar VKILL

Kill line character (typically Ctrl+U)

VREPRINT

public static final Attributes.ControlChar VREPRINT

Reprint line character (typically Ctrl+R)

VINTR

public static final Attributes.ControlChar VINTR

Interrupt character (typically Ctrl+C)

VQUIT

public static final Attributes.ControlChar VQUIT

Quit character (typically Ctrl+\)

VSUSP

public static final Attributes.ControlChar VSUSP

Suspend character (typically Ctrl+Z)

VDSUSP

public static final Attributes.ControlChar VDSUSP

Delayed suspend character

VSTART

public static final Attributes.ControlChar VSTART

Start output character (typically Ctrl+Q)

VSTOP

public static final Attributes.ControlChar VSTOP

Stop output character (typically Ctrl+S)

VLNEXT

public static final Attributes.ControlChar VLNEXT

Literal next character (typically Ctrl+V)

VDISCARD

public static final Attributes.ControlChar VDISCARD

Discard output character (typically Ctrl+O)

VMIN

public static final Attributes.ControlChar VMIN

Minimum number of characters for non-canonical read

VTIME

public static final Attributes.ControlChar VTIME

Timeout in deciseconds for non-canonical read

VSTATUS

public static final Attributes.ControlChar VSTATUS

Status request character (typically Ctrl+T)

Method Details

values

public static Attributes.ControlChar[] 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.ControlChar 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