Package org.jline.shell.impl

Class CommandHighlighter

java.lang.Object

org.jline.shell.impl.CommandHighlighter

All Implemented Interfaces:

Highlighter

public class CommandHighlighter
extends Object
implements Highlighter

Command-aware syntax highlighter for the shell.

Highlights the first word of the command line based on whether it is a known command in the dispatcher:

• Known commands are highlighted in bold
• Unknown commands are highlighted in red
• Pipeline operators (|, &&, ||, ;, etc.) are highlighted in cyan

An optional delegate Highlighter can be provided for composability. If provided, the delegate is called first, then command highlighting is applied on top.

Since:

4.0

Constructor Summary

Constructors

Constructor	Description
CommandHighlighter(CommandDispatcher dispatcher)	Creates a command highlighter with no delegate.
CommandHighlighter(CommandDispatcher dispatcher, Highlighter delegate)	Creates a command highlighter with an optional delegate.

Method Summary

Modifier and Type	Method	Description
AttributedString	highlight(LineReader reader, String buffer)	Highlights the provided text buffer with appropriate styling.
void	setErrorIndex(int errorIndex)	Sets a specific character position in the buffer to be highlighted as an error.
void	setErrorPattern(Pattern errorPattern)	Sets a regular expression pattern that identifies errors to be highlighted.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jline.reader.Highlighter

refresh

Constructor Details

CommandHighlighter

public CommandHighlighter(CommandDispatcher dispatcher)

Creates a command highlighter with no delegate.

Parameters:

dispatcher - the command dispatcher for command lookup

CommandHighlighter

public CommandHighlighter(CommandDispatcher dispatcher,
 Highlighter delegate)

Creates a command highlighter with an optional delegate.

When a delegate is provided, it is used to highlight the buffer first, and then command-specific highlighting is applied on top.

Parameters:

dispatcher - the command dispatcher for command lookup

delegate - the delegate highlighter, or null

Method Details

highlight

public AttributedString highlight(LineReader reader,
 String buffer)

Description copied from interface: Highlighter

Highlights the provided text buffer with appropriate styling.

This method is called by the LineReader to apply syntax highlighting to the current input line. It should analyze the buffer content and return an AttributedString with appropriate styling applied based on the content's syntax, structure, or other relevant characteristics.

Specified by:

highlight in interface Highlighter

Parameters:

reader - The LineReader instance requesting highlighting

buffer - The text buffer to be highlighted

Returns:

An AttributedString containing the highlighted buffer with styling applied

setErrorPattern

public void setErrorPattern(Pattern errorPattern)

Description copied from interface: Highlighter

Sets a regular expression pattern that identifies errors to be highlighted.

Text matching this pattern will typically be highlighted with error styling (often red or with a distinctive background color) to indicate problematic input.

Specified by:

setErrorPattern in interface Highlighter

Parameters:

errorPattern - A regular expression pattern that matches text to be highlighted as errors

setErrorIndex

public void setErrorIndex(int errorIndex)

Description copied from interface: Highlighter

Sets a specific character position in the buffer to be highlighted as an error.

This is typically used to indicate the exact position of a syntax error or other issue in the input line. The highlighter will apply error styling at this position.

Specified by:

setErrorIndex in interface Highlighter

Parameters:

errorIndex - The character index in the buffer to be highlighted as an error