Package org.jline.reader
Enum Class LineReader.Option
- All Implemented Interfaces:
Serializable
,Comparable<LineReader.Option>
,Constable
- Enclosing interface:
LineReader
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionif set and not at start of line before prompt, move to new linewhen displaying candidates, group them byCandidate.group()
list candidates below the field to be completedif completion is case insensitive or notif history search is fully case insensitiveuse camel case completion matcheruse type completion matcherAfter writing into the rightmost column, do we immediately move to the next line (the default)? Or do we wait until the next character.Disable the undo featureShow command options tab completion candidates for zero length wordInstead 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.display group name before each group (else display all group names first)when double tab to select candidate keep candidates grouped (else loose grouping)Automatic insertion of closing bracketWhen hitting the<tab>
key at the beginning of the line, insert a tabulation instead of completing.FileNameCompleter: Use '/' character as a file directory separator -
Method Summary
Modifier and TypeMethodDescriptionboolean
isDef()
final boolean
isSet
(Map<LineReader.Option, Boolean> options) static LineReader.Option
Returns the enum constant of this class with the specified name.static LineReader.Option[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
COMPLETE_IN_WORD
-
COMPLETE_MATCHER_CAMELCASE
use camel case completion matcher -
COMPLETE_MATCHER_TYPO
use type completion matcher -
DISABLE_EVENT_EXPANSION
-
HISTORY_VERIFY
-
HISTORY_IGNORE_SPACE
-
HISTORY_IGNORE_DUPS
-
HISTORY_REDUCE_BLANKS
-
HISTORY_BEEP
-
HISTORY_INCREMENTAL
-
HISTORY_TIMESTAMPED
-
AUTO_GROUP
when displaying candidates, group them byCandidate.group()
-
AUTO_MENU
-
AUTO_LIST
-
AUTO_MENU_LIST
list candidates below the field to be completed -
RECOGNIZE_EXACT
-
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) -
CASE_INSENSITIVE
if completion is case insensitive or not -
LIST_AMBIGUOUS
-
LIST_PACKED
-
LIST_ROWS_FIRST
-
GLOB_COMPLETE
-
MENU_COMPLETE
-
AUTO_FRESH_LINE
if set and not at start of line before prompt, move to new line -
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 exactlyN*columns
wide will useN
screen lines; otherwise it will useN+1
lines. When the cursor position is the right margin of the last line (i.e. afterN*columns
normal characters), if this option it set, the cursor will be remain on the last line (lineN-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
-
AUTO_REMOVE_SLASH
-
USE_FORWARD_SLASH
FileNameCompleter: Use '/' character as a file directory separator -
INSERT_TAB
When hitting the<tab>
key at the beginning of the line, insert a tabulation instead of completing. This is mainly useful whenBRACKETED_PASTE
is disabled, so that copy/paste of indented text does not trigger completion. -
MOUSE
-
DISABLE_HIGHLIGHTER
-
BRACKETED_PASTE
-
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
if history search is fully case insensitive -
INSERT_BRACKET
Automatic insertion of closing bracket -
EMPTY_WORD_OPTIONS
Show command options tab completion candidates for zero length word -
DISABLE_UNDO
Disable the undo feature
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
isSet
-
isDef
public boolean isDef()
-