Enum LineReader.Option

    • Enum Constant Detail

      • 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
      • AUTO_MENU_LIST

        public static final LineReader.Option AUTO_MENU_LIST
        list candidates below the field to be completed
      • 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
      • 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.
      • 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.
      • 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
    • Field Detail

      • def

        private final boolean def
    • Constructor Detail

      • Option

        private Option()
      • Option

        private Option​(boolean def)
    • 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​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • isSet

        public final boolean isSet​(java.util.Map<LineReader.Option,​java.lang.Boolean> options)
      • isDef

        public boolean isDef()