Class ArgumentCompleter.AbstractArgumentDelimiter

java.lang.Object
jline.console.completer.ArgumentCompleter.AbstractArgumentDelimiter
All Implemented Interfaces:
ArgumentCompleter.ArgumentDelimiter
Direct Known Subclasses:
ArgumentCompleter.WhitespaceArgumentDelimiter
Enclosing class:
ArgumentCompleter
public abstract static class ArgumentCompleter.AbstractArgumentDelimiter extends Object implements ArgumentCompleter.ArgumentDelimiter
Abstract implementation of a delimiter that uses the isDelimiter(CharSequence, int) method to determine if a particular character should be used as a delimiter.
Since:
2.3

  • Field Details

    • quoteChars

      private char[] quoteChars

    • escapeChars

      private char[] escapeChars

  • Constructor Details

    • AbstractArgumentDelimiter

      public AbstractArgumentDelimiter()

  • Method Details

    • setQuoteChars

      public void setQuoteChars(char[] chars)

    • getQuoteChars

      public char[] getQuoteChars()

    • setEscapeChars

      public void setEscapeChars(char[] chars)

    • getEscapeChars

      public char[] getEscapeChars()

    • delimit

      public ArgumentCompleter.ArgumentList delimit(CharSequence buffer, int cursor)
      Description copied from interface: ArgumentCompleter.ArgumentDelimiter
      Break the specified buffer into individual tokens that can be completed on their own.
      Specified by:
      delimit in interface ArgumentCompleter.ArgumentDelimiter
      Parameters:
      buffer - The buffer to split
      cursor - The current position of the cursor in the buffer
      Returns:
      The tokens

    • isDelimiter

      public boolean isDelimiter(CharSequence buffer, int pos)
      Returns true if the specified character is a whitespace parameter. Check to ensure that the character is not escaped by any of getQuoteChars(), and is not escaped by ant of the getEscapeChars(), and returns true from isDelimiterChar(CharSequence, int).
      Specified by:
      isDelimiter in interface ArgumentCompleter.ArgumentDelimiter
      Parameters:
      buffer - The complete command buffer
      pos - The index of the character in the buffer
      Returns:
      True if the character should be a delimiter

    • isQuoted

      public boolean isQuoted(CharSequence buffer, int pos)

    • isQuoteChar

      public boolean isQuoteChar(CharSequence buffer, int pos)

    • isEscapeChar

      public boolean isEscapeChar(CharSequence buffer, int pos)
      Check if this character is a valid escape char (i.e. one that has not been escaped)

    • isEscaped

      public boolean isEscaped(CharSequence buffer, int pos)
      Check if a character is escaped (i.e. if the previous character is an escape)
      Parameters:
      buffer - the buffer to check in
      pos - the position of the character to check
      Returns:
      true if the character at the specified position in the given buffer is an escape character and the character immediately preceding it is not an escape character.

    • isDelimiterChar

      public abstract boolean isDelimiterChar(CharSequence buffer, int pos)
      Returns true if the character at the specified position if a delimiter. This method will only be called if the character is not enclosed in any of the getQuoteChars(), and is not escaped by ant of the getEscapeChars(). To perform escaping manually, override isDelimiter(CharSequence, int) instead.