Module org.jline.reader
Package org.jline.reader

Interface Highlighter

All Known Implementing Classes:
DefaultHighlighter
public interface Highlighter

  • Method Summary

    Modifier and Type
    Method
    Description
    org.jline.utils.AttributedString
    highlight(LineReader reader, String buffer)
    Highlight buffer
    default void
    refresh(LineReader reader)
    Refresh highlight configuration
    void
    setErrorIndex(int errorIndex)
    Set error index to be highlighted
    void
    setErrorPattern(Pattern errorPattern)
    Set error pattern to be highlighted

  • Method Details

    • highlight

      org.jline.utils.AttributedString highlight(LineReader reader, String buffer)
      Highlight buffer
      Parameters:
      reader - LineReader
      buffer - the buffer to be highlighted
      Returns:
      highlighted buffer

    • refresh

      default void refresh(LineReader reader)
      Refresh highlight configuration

    • setErrorPattern

      void setErrorPattern(Pattern errorPattern)
      Set error pattern to be highlighted
      Parameters:
      errorPattern - error pattern to be highlighted

    • setErrorIndex

      void setErrorIndex(int errorIndex)
      Set error index to be highlighted
      Parameters:
      errorIndex - error index to be highlighted