Enum VariableValues

java.lang.Object
java.lang.Enum<VariableValues>
org.aesh.readline.editing.VariableValues
All Implemented Interfaces:
Serializable, Comparable<VariableValues>, java.lang.constant.Constable
public enum VariableValues extends Enum<VariableValues>
Defines the allowed values for each readline configuration variable.
Author:
Ståle W. Pedersen

  • Enum Constant Details

    • BELL_STYLE

      public static final VariableValues BELL_STYLE
      Bell style values: none, visible, audible.

    • BIND_TTY_SPECIAL_CHARS

      public static final VariableValues BIND_TTY_SPECIAL_CHARS
      Bind TTY special chars: on/off.

    • COMMENT_BEGIN

      public static final VariableValues COMMENT_BEGIN
      Comment begin string (free-form).

    • COMPLETION_DISPLAY_WIDTH

      public static final VariableValues COMPLETION_DISPLAY_WIDTH
      Completion display width (numeric).

    • COMPLETION_IGNORE_CASE

      public static final VariableValues COMPLETION_IGNORE_CASE
      Completion ignore case: on/off.

    • COMPLETION_MAP_CASE

      public static final VariableValues COMPLETION_MAP_CASE
      Completion map case: on/off.

    • COMPLETION_PREFIX_DISPLAY_LENGTH

      public static final VariableValues COMPLETION_PREFIX_DISPLAY_LENGTH
      Completion prefix display length (numeric).

    • COMPLETION_QUERY_ITEMS

      public static final VariableValues COMPLETION_QUERY_ITEMS
      Completion query items threshold (numeric).

    • CONVERT_META

      public static final VariableValues CONVERT_META
      Convert meta characters: on/off.

    • DISABLE_COMPLETION

      public static final VariableValues DISABLE_COMPLETION
      Disable completion: on/off.

    • EDITING_MODE

      public static final VariableValues EDITING_MODE
      Editing mode: vi or emacs.

    • ECHO_CONTROL_CHARACTERS

      public static final VariableValues ECHO_CONTROL_CHARACTERS
      Echo control characters: on/off.

    • ENABLE_KEYPAD

      public static final VariableValues ENABLE_KEYPAD
      Enable keypad: on/off.

    • EXPAND_TILDE

      public static final VariableValues EXPAND_TILDE
      Expand tilde: on/off.

    • HISTORY_PRESERVE_POINT

      public static final VariableValues HISTORY_PRESERVE_POINT
      History preserve point: on/off.

    • HISTORY_SIZE

      public static final VariableValues HISTORY_SIZE
      History size (numeric).

    • HISTORY_SCROLL_MODE

      public static final VariableValues HISTORY_SCROLL_MODE
      History scroll mode: on/off.

    • INPUT_META

      public static final VariableValues INPUT_META
      Input meta: on/off.

    • ISEARCH_TERMINATORS

      public static final VariableValues ISEARCH_TERMINATORS
      Isearch terminators (free-form).

    • KEYMAP

      public static final VariableValues KEYMAP
      Keymap names for different editing contexts.

    • MARK_DIRECTORIES

      public static final VariableValues MARK_DIRECTORIES
      Mark directories: on/off.

    • MARK_MODIFIED_LINES

      public static final VariableValues MARK_MODIFIED_LINES
      Mark modified lines: on/off.

    • MARK_SYMLINKED_DIRECTORIES

      public static final VariableValues MARK_SYMLINKED_DIRECTORIES
      Mark symlinked directories: on/off.

    • MATCH_HIDDEN_FILES

      public static final VariableValues MATCH_HIDDEN_FILES
      Match hidden files: on/off.

    • OUTPUT_META

      public static final VariableValues OUTPUT_META
      Output meta: on/off.

    • PAGE_COMPLETIONS

      public static final VariableValues PAGE_COMPLETIONS
      Page completions: on/off.

    • REVERT_ALL_AT_NEWLINE

      public static final VariableValues REVERT_ALL_AT_NEWLINE
      Revert all at newline: on/off.

    • SHOW_ALL_IF_AMBIGUOUS

      public static final VariableValues SHOW_ALL_IF_AMBIGUOUS
      Show all if ambiguous: on/off.

    • SHOW_ALL_IF_UNMODIFIED

      public static final VariableValues SHOW_ALL_IF_UNMODIFIED
      Show all if unmodified: on/off.

    • SKIP_COMPLETED_TEXT

      public static final VariableValues SKIP_COMPLETED_TEXT
      Skip completed text: on/off.

    • VISIBLE_STATS

      public static final VariableValues VISIBLE_STATS
      Visible stats: on/off.

  • Method Details

    • values

      public static VariableValues[] 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 VariableValues 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

    • getValuesByVariable

      public static List<String> getValuesByVariable(Variable variable)
      Get the allowed values for a given variable.
      Parameters:
      variable - the variable to look up
      Returns:
      the list of allowed values, or an empty list if not found

    • hasValue

      public boolean hasValue()
      Check if this variable has defined values.
      Returns:
      true if there are allowed values defined