LineReader.Option (GraalVM SDK Java API Reference)

java.lang.Object
- java.lang.Enum<LineReader.Option>
- - org.graalvm.shadowed.org.jline.reader.LineReader.Option

All Implemented Interfaces:

Serializable, Comparable<LineReader.Option>, java.lang.constant.Constable

Enclosing interface:

LineReader
```
public static enum LineReader.Option
extends Enum<LineReader.Option>
```

Nested Class Summary
- Nested classes/interfaces inherited from class java.lang.Enum
  Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AUTO_FRESH_LINE` if set and not at start of line before prompt, move to new line
`AUTO_GROUP` when displaying candidates, group them by `Candidate.group()`
`AUTO_LIST`
`AUTO_MENU`
`AUTO_MENU_LIST` list candidates below the field to be completed
`AUTO_PARAM_SLASH`
`AUTO_REMOVE_SLASH`
`BRACKETED_PASTE`
`CASE_INSENSITIVE` if completion is case insensitive or not
`CASE_INSENSITIVE_SEARCH` if history search is fully case insensitive
`COMPLETE_IN_WORD`
`COMPLETE_MATCHER_CAMELCASE` use camel case completion matcher
`COMPLETE_MATCHER_TYPO` use type completion matcher
`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.
`DISABLE_EVENT_EXPANSION`
`DISABLE_HIGHLIGHTER`
`DISABLE_UNDO` Disable the undo feature
`EMPTY_WORD_OPTIONS` Show command options tab completion candidates for zero length word
`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.
`GLOB_COMPLETE`
`GROUP` display group name before each group (else display all group names first)
`GROUP_PERSIST` when double tab to select candidate keep candidates grouped (else loose grouping)
`HISTORY_BEEP`
`HISTORY_IGNORE_DUPS`
`HISTORY_IGNORE_SPACE`
`HISTORY_INCREMENTAL`
`HISTORY_REDUCE_BLANKS`
`HISTORY_TIMESTAMPED`
`HISTORY_VERIFY`
`INSERT_BRACKET` Automatic insertion of closing bracket
`INSERT_TAB` When hitting the `<tab>` key at the beginning of the line, insert a tabulation instead of completing.
`LIST_AMBIGUOUS`
`LIST_PACKED`
`LIST_ROWS_FIRST`
`MENU_COMPLETE`
`MOUSE`
`RECOGNIZE_EXACT`
`USE_FORWARD_SLASH` FileNameCompleter: Use '/' character as a file directory separator

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`isDef()`
`boolean`	`isSet(Map<LineReader.Option,Boolean> options)`
`static LineReader.Option`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static LineReader.Option[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - 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
```
  - MENU_COMPLETE
```
public static final LineReader.Option MENU_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 LineReader.Option.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.
  - CASE_INSENSITIVE_SEARCH
```
public static final LineReader.Option CASE_INSENSITIVE_SEARCH
```
    if history search is fully case insensitive
  - 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 Detail
  - values
```
public static LineReader.Option[] values()
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static LineReader.Option valueOf(String name)
```
    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
  - isSet
```
public final boolean isSet(Map<LineReader.Option,Boolean> options)
```
  - isDef
```
public boolean isDef()
```

Enum LineReader.Option

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

COMPLETE_IN_WORD

COMPLETE_MATCHER_CAMELCASE

COMPLETE_MATCHER_TYPO

DISABLE_EVENT_EXPANSION

HISTORY_VERIFY

HISTORY_IGNORE_SPACE

HISTORY_IGNORE_DUPS

HISTORY_REDUCE_BLANKS

HISTORY_BEEP

HISTORY_INCREMENTAL

HISTORY_TIMESTAMPED

AUTO_GROUP

AUTO_MENU

AUTO_LIST

AUTO_MENU_LIST

RECOGNIZE_EXACT

GROUP

GROUP_PERSIST

CASE_INSENSITIVE

LIST_AMBIGUOUS

LIST_PACKED

LIST_ROWS_FIRST

GLOB_COMPLETE

MENU_COMPLETE

AUTO_FRESH_LINE

DELAY_LINE_WRAP

AUTO_PARAM_SLASH

AUTO_REMOVE_SLASH

USE_FORWARD_SLASH

INSERT_TAB

MOUSE

DISABLE_HIGHLIGHTER

BRACKETED_PASTE

ERASE_LINE_ON_FINISH

CASE_INSENSITIVE_SEARCH

INSERT_BRACKET

EMPTY_WORD_OPTIONS

DISABLE_UNDO

Method Detail

values

valueOf

isSet

isDef