Package org.aesh.readline

Enum ReadlineFlag

java.lang.Object
java.lang.Enum<ReadlineFlag>
org.aesh.readline.ReadlineFlag
All Implemented Interfaces:
Serializable, Comparable<ReadlineFlag>, java.lang.constant.Constable
public enum ReadlineFlag extends Enum<ReadlineFlag>
Enumeration of flags that control readline behavior.
Author:
Ståle W. Pedersen

  • Enum Constant Details

    • NO_PROMPT_REDRAW_ON_INTR

      public static final ReadlineFlag NO_PROMPT_REDRAW_ON_INTR
      Do not redraw prompt on INTR signal Default behaviour is to redraw .

    • IGNORE_EOF

      public static final ReadlineFlag IGNORE_EOF
      Ignore EOF signal a given number of times

    • NO_MULTI_LINE_ON_QUOTE

      public static final ReadlineFlag NO_MULTI_LINE_ON_QUOTE
      Do not activate multi-line mode
      • 0 = Disable for both single and double quote
      • 1 = Disable for double quote
      • 2 = Disable for single quote

    • NO_COMMENT_DISCARD

      public static final ReadlineFlag NO_COMMENT_DISCARD
      Do not discard lines starting with '#'

    • NO_GRAPHEME_CLUSTER_MODE

      public static final ReadlineFlag NO_GRAPHEME_CLUSTER_MODE
      Do not automatically enable Mode 2027 (grapheme cluster segmentation) for terminals that support it

    • NO_SYNCHRONIZED_OUTPUT

      public static final ReadlineFlag NO_SYNCHRONIZED_OUTPUT
      Do not automatically use Mode 2026 (synchronized output) for terminals that support it

    • NO_SHELL_INTEGRATION

      public static final ReadlineFlag NO_SHELL_INTEGRATION
      Do not emit OSC 133 shell integration sequences.

      When set, Readline will not emit OSC 133 prompt start (A), prompt end (B), or command start (C) markers.

  • Method Details

    • values

      public static ReadlineFlag[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static ReadlineFlag valueOf(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:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null