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:
  • Enum Constant Details

  • 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