Package org.jline.terminal
Enum Attributes.ControlChar
- java.lang.Object
-
- java.lang.Enum<Attributes.ControlChar>
-
- org.jline.terminal.Attributes.ControlChar
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<Attributes.ControlChar>
- Enclosing class:
- Attributes
public static enum Attributes.ControlChar extends java.lang.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 readVTIME
- Timeout in deciseconds for non-canonical read
Control characters can be accessed and modified using
Attributes.getControlChar(ControlChar)
andAttributes.setControlChar(ControlChar, int)
.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description VDISCARD
Discard output character (typically Ctrl+O)VDSUSP
Delayed suspend characterVEOF
End-of-file character (typically Ctrl+D)VEOL
End-of-line characterVEOL2
Secondary end-of-line characterVERASE
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 readVQUIT
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 readVWERASE
Word erase character (typically Ctrl+W)
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static Attributes.ControlChar
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static Attributes.ControlChar[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
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 Detail
-
values
public static Attributes.ControlChar[] 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 (Attributes.ControlChar c : Attributes.ControlChar.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static Attributes.ControlChar valueOf(java.lang.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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
-