Package org.jline.terminal
Enum Class Attributes.ControlChar
- All Implemented Interfaces:
Serializable
,Comparable<Attributes.ControlChar>
,Constable
- Enclosing class:
Attributes
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 readVTIME
- 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:
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionDiscard output character (typically Ctrl+O)Delayed suspend characterEnd-of-file character (typically Ctrl+D)End-of-line characterSecondary end-of-line characterErase character (typically Backspace)Interrupt character (typically Ctrl+C)Kill line character (typically Ctrl+U)Literal next character (typically Ctrl+V)Minimum number of characters for non-canonical readQuit character (typically Ctrl+\)Reprint line character (typically Ctrl+R)Start output character (typically Ctrl+Q)Status request character (typically Ctrl+T)Stop output character (typically Ctrl+S)Suspend character (typically Ctrl+Z)Timeout in deciseconds for non-canonical readWord erase character (typically Ctrl+W) -
Method Summary
Modifier and TypeMethodDescriptionstatic Attributes.ControlChar
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.
-
Enum Constant Details
-
VEOF
End-of-file character (typically Ctrl+D) -
VEOL
End-of-line character -
VEOL2
Secondary end-of-line character -
VERASE
Erase character (typically Backspace) -
VWERASE
Word erase character (typically Ctrl+W) -
VKILL
Kill line character (typically Ctrl+U) -
VREPRINT
Reprint line character (typically Ctrl+R) -
VINTR
Interrupt character (typically Ctrl+C) -
VQUIT
Quit character (typically Ctrl+\) -
VSUSP
Suspend character (typically Ctrl+Z) -
VDSUSP
Delayed suspend character -
VSTART
Start output character (typically Ctrl+Q) -
VSTOP
Stop output character (typically Ctrl+S) -
VLNEXT
Literal next character (typically Ctrl+V) -
VDISCARD
Discard output character (typically Ctrl+O) -
VMIN
Minimum number of characters for non-canonical read -
VTIME
Timeout in deciseconds for non-canonical read -
VSTATUS
Status request character (typically Ctrl+T)
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-