Package org.jline.reader

Enum Class LineReader.Option

java.lang.Object
java.lang.Enum<LineReader.Option>
org.jline.reader.LineReader.Option
All Implemented Interfaces:
Serializable, Comparable<LineReader.Option>, Constable
Enclosing interface:
LineReader
public static enum LineReader.Option extends Enum<LineReader.Option>

  • Enum Constant Details

    • COMPLETE_IN_WORD

      public static final LineReader.Option COMPLETE_IN_WORD

    • COMPLETE_MATCHER_CAMELCASE

      public static final LineReader.Option COMPLETE_MATCHER_CAMELCASE
      use camel case completion matcher

    • COMPLETE_MATCHER_TYPO

      public static final LineReader.Option COMPLETE_MATCHER_TYPO
      use type completion matcher

    • DISABLE_EVENT_EXPANSION

      public static final LineReader.Option DISABLE_EVENT_EXPANSION

    • HISTORY_VERIFY

      public static final LineReader.Option HISTORY_VERIFY

    • HISTORY_IGNORE_SPACE

      public static final LineReader.Option HISTORY_IGNORE_SPACE

    • HISTORY_IGNORE_DUPS

      public static final LineReader.Option HISTORY_IGNORE_DUPS

    • HISTORY_REDUCE_BLANKS

      public static final LineReader.Option HISTORY_REDUCE_BLANKS

    • HISTORY_BEEP

      public static final LineReader.Option HISTORY_BEEP

    • HISTORY_INCREMENTAL

      public static final LineReader.Option HISTORY_INCREMENTAL

    • HISTORY_TIMESTAMPED

      public static final LineReader.Option HISTORY_TIMESTAMPED

    • AUTO_GROUP

      public static final LineReader.Option AUTO_GROUP
      when displaying candidates, group them by Candidate.group()

    • AUTO_MENU

      public static final LineReader.Option AUTO_MENU

    • AUTO_LIST

      public static final LineReader.Option AUTO_LIST

    • AUTO_MENU_LIST

      public static final LineReader.Option AUTO_MENU_LIST
      list candidates below the field to be completed

    • RECOGNIZE_EXACT

      public static final LineReader.Option RECOGNIZE_EXACT

    • GROUP

      public static final LineReader.Option GROUP
      display group name before each group (else display all group names first)

    • GROUP_PERSIST

      public static final LineReader.Option GROUP_PERSIST
      when double tab to select candidate keep candidates grouped (else loose grouping)

    • CASE_INSENSITIVE

      public static final LineReader.Option CASE_INSENSITIVE
      if completion is case insensitive or not

    • LIST_AMBIGUOUS

      public static final LineReader.Option LIST_AMBIGUOUS

    • LIST_PACKED

      public static final LineReader.Option LIST_PACKED

    • LIST_ROWS_FIRST

      public static final LineReader.Option LIST_ROWS_FIRST

    • GLOB_COMPLETE

      public static final LineReader.Option GLOB_COMPLETE

    • AUTO_FRESH_LINE

      public static final LineReader.Option AUTO_FRESH_LINE
      if set and not at start of line before prompt, move to new line

    • DELAY_LINE_WRAP

      public static final LineReader.Option DELAY_LINE_WRAP
      After writing into the rightmost column, do we immediately move to the next line (the default)? Or do we wait until the next character. If set, an input line that is exactly N*columns wide will use N screen lines; otherwise it will use N+1 lines. When the cursor position is the right margin of the last line (i.e. after N*columns normal characters), if this option it set, the cursor will be remain on the last line (line N-1, zero-origin); if unset the cursor will be on the empty next line. Regardless, for all except the last screen line if the cursor is at the right margin, it will be shown at the start of the next line.

    • AUTO_PARAM_SLASH

      public static final LineReader.Option AUTO_PARAM_SLASH

    • AUTO_REMOVE_SLASH

      public static final LineReader.Option AUTO_REMOVE_SLASH

    • USE_FORWARD_SLASH

      public static final LineReader.Option USE_FORWARD_SLASH
      FileNameCompleter: Use '/' character as a file directory separator

    • INSERT_TAB

      public static final LineReader.Option INSERT_TAB
      When hitting the <tab> key at the beginning of the line, insert a tabulation instead of completing. This is mainly useful when BRACKETED_PASTE is disabled, so that copy/paste of indented text does not trigger completion.

    • MOUSE

      public static final LineReader.Option MOUSE

    • DISABLE_HIGHLIGHTER

      public static final LineReader.Option DISABLE_HIGHLIGHTER

    • BRACKETED_PASTE

      public static final LineReader.Option BRACKETED_PASTE

    • ERASE_LINE_ON_FINISH

      public static final LineReader.Option ERASE_LINE_ON_FINISH
      Instead of printing a new line when the line is read, the entire line (including the prompt) will be erased, thereby leaving the screen as it was before the readLine call.

    • INSERT_BRACKET

      public static final LineReader.Option INSERT_BRACKET
      Automatic insertion of closing bracket

    • EMPTY_WORD_OPTIONS

      public static final LineReader.Option EMPTY_WORD_OPTIONS
      Show command options tab completion candidates for zero length word

    • DISABLE_UNDO

      public static final LineReader.Option DISABLE_UNDO
      Disable the undo feature

  • Method Details

    • values

      public static LineReader.Option[] 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 LineReader.Option 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

    • isSet

      public final boolean isSet(Map<LineReader.Option,Boolean> options)

    • isDef

      public boolean isDef()