- java.lang.Object
-
- java.lang.Enum<LineReader.Option>
-
- org.jline.reader.LineReader.Option
-
- All Implemented Interfaces:
Serializable,Comparable<LineReader.Option>
- Enclosing interface:
- LineReader
public static enum LineReader.Option extends Enum<LineReader.Option>
-
-
Enum Constant Summary
Enum Constants Enum Constant Description AUTO_FRESH_LINEif set and not at start of line before prompt, move to new lineAUTO_GROUPwhen displaying candidates, group them byCandidate.group()AUTO_LISTAUTO_MENUAUTO_MENU_LISTlist candidates below the field to be completedAUTO_PARAM_SLASHAUTO_REMOVE_SLASHBRACKETED_PASTECASE_INSENSITIVEif completion is case insensitive or notCASE_INSENSITIVE_SEARCHif history search is fully case insensitiveCOMPLETE_IN_WORDCOMPLETE_MATCHER_CAMELCASEuse camel case completion matcherCOMPLETE_MATCHER_TYPOuse type completion matcherDELAY_LINE_WRAPAfter 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_EXPANSIONDISABLE_HIGHLIGHTEREMPTY_WORD_OPTIONSShow command options tab completion candidates for zero length wordERASE_LINE_ON_FINISHInstead 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_COMPLETEGROUPdisplay group name before each group (else display all group names first)GROUP_PERSISTwhen double tab to select candidate keep candidates grouped (else loose grouping)HISTORY_BEEPHISTORY_IGNORE_DUPSHISTORY_IGNORE_SPACEHISTORY_INCREMENTALHISTORY_REDUCE_BLANKSHISTORY_TIMESTAMPEDHISTORY_VERIFYINSERT_BRACKETAutomatic insertion of closing bracketINSERT_TABWhen hitting the<tab>key at the beginning of the line, insert a tabulation instead of completing.LIST_AMBIGUOUSLIST_PACKEDLIST_ROWS_FIRSTMENU_COMPLETEMOUSERECOGNIZE_EXACTUSE_FORWARD_SLASHFileNameCompleter: Use '/' character as a file directory separator
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanisDef()booleanisSet(Map<LineReader.Option,Boolean> options)static LineReader.OptionvalueOf(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.
-
-
-
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 byCandidate.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 exactlyN*columnswide will useNscreen lines; otherwise it will useN+1lines. When the cursor position is the right margin of the last line (i.e. afterN*columnsnormal 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
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 whenBRACKETED_PASTEis 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
-
-
Method Detail
-
values
public static LineReader.Option[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (LineReader.Option c : LineReader.Option.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static LineReader.Option 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 nameNullPointerException- if the argument is null
-
isSet
public final boolean isSet(Map<LineReader.Option,Boolean> options)
-
isDef
public boolean isDef()
-
-