Enum Variable

java.lang.Object
java.lang.Enum<Variable>
org.aesh.readline.editing.Variable
All Implemented Interfaces:
Serializable, Comparable<Variable>, java.lang.constant.Constable
public enum Variable extends Enum<Variable>
Enumeration of readline configuration variables corresponding to inputrc settings.
Author:
Ståle W. Pedersen

  • Nested Class Summary

    Nested classes/interfaces inherited from class Enum

    Enum.EnumDesc<E>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    BELL_STYLE
    Controls how readline indicates a terminal bell.
    BIND_TTY_SPECIAL_CHARS
    If set to on, readline attempts to bind the control characters treated specially by the kernel's terminal driver to their readline equivalents.
    COMMENT_BEGIN
    The string to insert at the beginning of the line when the insert-comment command is executed.
    COMPLETION_DISPLAY_WIDTH
    The number of screen columns used to display possible matches when performing completion.
    COMPLETION_IGNORE_CASE
    If set to on, readline performs filename matching and completion in a case-insensitive fashion.
    COMPLETION_MAP_CASE
    If set to on, and completion-ignore-case is enabled, readline treats hyphens and underscores as equivalent.
    COMPLETION_PREFIX_DISPLAY_LENGTH
    The length in characters of the common prefix of a list of possible completions that is displayed without modification.
    COMPLETION_QUERY_ITEMS
    The number of possible completions that determines when the user is asked whether the list of possibilities should be displayed.
    CONVERT_META
    If set to on, readline converts characters with the eighth bit set to an ASCII key sequence.
    DISABLE_COMPLETION
    If set to on, readline inhibits word completion.
    ECHO_CONTROL_CHARACTERS
    If set to on, readline displays control characters in a visible fashion when echoing.
    EDITING_MODE
    Controls whether readline starts in emacs or vi editing mode.
    ENABLE_KEYPAD
    If set to on, readline enables the application keypad when called.
    EXPAND_TILDE
    If set to on, tilde expansion is performed when readline attempts word completion.
    HISTORY_PRESERVE_POINT
    If set to on, the history code attempts to place the point at the same location on each history line retrieved with previous-history or next-history.
    HISTORY_SCROLL_MODE
    Controls the scroll mode behavior when navigating through history.
    HISTORY_SIZE
    Sets the maximum number of history entries saved in the history list.
    INPUT_META
    If set to on, readline enables eight-bit input regardless of terminal claims.
    ISEARCH_TERMINATORS
    The string of characters that should terminate an incremental search.
    KEYMAP
    Sets readline's keymap.
    MARK_DIRECTORIES
    If set to on, completed directory names have a slash appended.
    MARK_MODIFIED_LINES
    If set to on, history lines that have been modified are displayed with a preceding asterisk.
    MARK_SYMLINKED_DIRECTORIES
    If set to on, completed names which are symbolic links to directories have a slash appended.
    MATCH_HIDDEN_FILES
    If set to on, readline matches files whose names begin with a dot when performing filename completion.
    MENU_COMPLETE_DISPLAY_PREFIX
    If set to on, menu completion displays the common prefix of the list of possible completions.
    OUTPUT_META
    If set to on, readline displays characters with the eighth bit set directly rather than as a meta-prefixed escape sequence.
    PAGE_COMPLETIONS
    If set to on, readline uses an internal more-like pager to display a screenful of possible completions at a time.
    PRINT_COMPLETIONS_HORIZONTALLY
    If set to on, readline displays completions with matches sorted horizontally in alphabetical order.
    REVERT_ALL_AT_NEWLINE
    If set to on, readline undoes all changes to history lines before returning when accept-line is executed.
    SHOW_ALL_IF_AMBIGUOUS
    If set to on, words which have more than one possible completion cause the matches to be listed immediately.
    SHOW_ALL_IF_UNMODIFIED
    If set to on, words which have more than one possible completion without any possible partial completion cause the matches to be listed immediately.
    SKIP_COMPLETED_TEXT
    If set to on, this alters the default completion behavior when inserting a single match into the line.
    VISIBLE_STATS
    If set to on, a character denoting a file's type is appended to the filename when listing possible completions.

  • Method Summary

    Modifier and Type
    Method
    Description
    static Variable
    findVariable(String value)
    Finds a Variable by its inputrc string value.
    String
    getValue()
    Returns the inputrc string representation of this variable.
    static Variable
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static Variable[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • BELL_STYLE

      public static final Variable BELL_STYLE
      Controls how readline indicates a terminal bell. Values: none, visible, audible.

    • BIND_TTY_SPECIAL_CHARS

      public static final Variable BIND_TTY_SPECIAL_CHARS
      If set to on, readline attempts to bind the control characters treated specially by the kernel's terminal driver to their readline equivalents.

    • COMMENT_BEGIN

      public static final Variable COMMENT_BEGIN
      The string to insert at the beginning of the line when the insert-comment command is executed.

    • COMPLETION_DISPLAY_WIDTH

      public static final Variable COMPLETION_DISPLAY_WIDTH
      The number of screen columns used to display possible matches when performing completion.

    • COMPLETION_IGNORE_CASE

      public static final Variable COMPLETION_IGNORE_CASE
      If set to on, readline performs filename matching and completion in a case-insensitive fashion.

    • COMPLETION_MAP_CASE

      public static final Variable COMPLETION_MAP_CASE
      If set to on, and completion-ignore-case is enabled, readline treats hyphens and underscores as equivalent.

    • COMPLETION_PREFIX_DISPLAY_LENGTH

      public static final Variable COMPLETION_PREFIX_DISPLAY_LENGTH
      The length in characters of the common prefix of a list of possible completions that is displayed without modification.

    • COMPLETION_QUERY_ITEMS

      public static final Variable COMPLETION_QUERY_ITEMS
      The number of possible completions that determines when the user is asked whether the list of possibilities should be displayed.

    • CONVERT_META

      public static final Variable CONVERT_META
      If set to on, readline converts characters with the eighth bit set to an ASCII key sequence.

    • DISABLE_COMPLETION

      public static final Variable DISABLE_COMPLETION
      If set to on, readline inhibits word completion.

    • EDITING_MODE

      public static final Variable EDITING_MODE
      Controls whether readline starts in emacs or vi editing mode.

    • ECHO_CONTROL_CHARACTERS

      public static final Variable ECHO_CONTROL_CHARACTERS
      If set to on, readline displays control characters in a visible fashion when echoing.

    • ENABLE_KEYPAD

      public static final Variable ENABLE_KEYPAD
      If set to on, readline enables the application keypad when called.

    • EXPAND_TILDE

      public static final Variable EXPAND_TILDE
      If set to on, tilde expansion is performed when readline attempts word completion.

    • HISTORY_PRESERVE_POINT

      public static final Variable HISTORY_PRESERVE_POINT
      If set to on, the history code attempts to place the point at the same location on each history line retrieved with previous-history or next-history.

    • HISTORY_SIZE

      public static final Variable HISTORY_SIZE
      Sets the maximum number of history entries saved in the history list.

    • HISTORY_SCROLL_MODE

      public static final Variable HISTORY_SCROLL_MODE
      Controls the scroll mode behavior when navigating through history.

    • INPUT_META

      public static final Variable INPUT_META
      If set to on, readline enables eight-bit input regardless of terminal claims.

    • ISEARCH_TERMINATORS

      public static final Variable ISEARCH_TERMINATORS
      The string of characters that should terminate an incremental search.

    • KEYMAP

      public static final Variable KEYMAP
      Sets readline's keymap. Valid keymap names are emacs, emacs-standard, vi, vi-move, vi-command, vi-insert.

    • MARK_DIRECTORIES

      public static final Variable MARK_DIRECTORIES
      If set to on, completed directory names have a slash appended.

    • MARK_MODIFIED_LINES

      public static final Variable MARK_MODIFIED_LINES
      If set to on, history lines that have been modified are displayed with a preceding asterisk.

    • MARK_SYMLINKED_DIRECTORIES

      public static final Variable MARK_SYMLINKED_DIRECTORIES
      If set to on, completed names which are symbolic links to directories have a slash appended.

    • MATCH_HIDDEN_FILES

      public static final Variable MATCH_HIDDEN_FILES
      If set to on, readline matches files whose names begin with a dot when performing filename completion.

    • OUTPUT_META

      public static final Variable OUTPUT_META
      If set to on, readline displays characters with the eighth bit set directly rather than as a meta-prefixed escape sequence.

    • PAGE_COMPLETIONS

      public static final Variable PAGE_COMPLETIONS
      If set to on, readline uses an internal more-like pager to display a screenful of possible completions at a time.

    • REVERT_ALL_AT_NEWLINE

      public static final Variable REVERT_ALL_AT_NEWLINE
      If set to on, readline undoes all changes to history lines before returning when accept-line is executed.

    • SHOW_ALL_IF_AMBIGUOUS

      public static final Variable SHOW_ALL_IF_AMBIGUOUS
      If set to on, words which have more than one possible completion cause the matches to be listed immediately.

    • SHOW_ALL_IF_UNMODIFIED

      public static final Variable SHOW_ALL_IF_UNMODIFIED
      If set to on, words which have more than one possible completion without any possible partial completion cause the matches to be listed immediately.

    • SKIP_COMPLETED_TEXT

      public static final Variable SKIP_COMPLETED_TEXT
      If set to on, this alters the default completion behavior when inserting a single match into the line.

    • VISIBLE_STATS

      public static final Variable VISIBLE_STATS
      If set to on, a character denoting a file's type is appended to the filename when listing possible completions.

  • Method Details

    • values

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

    • getValue

      public String getValue()
      Returns the inputrc string representation of this variable.
      Returns:
      the inputrc string value

    • findVariable

      public static Variable findVariable(String value)
      Finds a Variable by its inputrc string value.
      Parameters:
      value - the inputrc string value to search for
      Returns:
      the matching Variable, or null if no match is found or if the value is null