Top Description Fields Constructors Methods

org.hibernate.engine.jdbc.internal

public final Class HighlightingFormatter

Class Inheritance

extends Object
implements Formatter

java.lang.Object
org.hibernate.engine.jdbc.internal.HighlightingFormatter

All Implemented Interfaces

org.hibernate.engine.jdbc.internal.Formatter

Imports

org.hibernate.engine.jdbc.env.spi.AnsiSqlKeywords, org.hibernate.internal.util.StringHelper, java.util.Arrays, .HashSet, .Set, .StringTokenizer

Performs basic syntax highlighting for SQL using ANSI escape codes.

Author: Gavin King

Field Summary

Modifier and Type	Field and Description
public static final Formatter	INSTANCE
private final String	keywordEscape
private static final Set<String>	KEYWORDS
private final String	normalEscape
private final String	quotedEscape
private final String	stringEscape
private static final String	SYMBOLS_AND_WS

Constructor Summary

Access	Constructor and Description
public	HighlightingFormatter(String the ANSI escape code to use for highlighting SQL keywords keywordCode, String the ANSI escape code to use for highlighting SQL strings stringCode, String quotedCode)

Method Summary

Modifier and Type	Method and Description
private static String	escape(String code)
public String	format(String The original SQL string sql) Implements org.hibernate.engine.jdbc.internal.Formatter.format. Format the source SQL string.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

INSTANCE	back to summary
public static final Formatter INSTANCE

keywordEscape	back to summary
private final String keywordEscape

KEYWORDS	back to summary
private static final Set<String> KEYWORDS

normalEscape	back to summary
private final String normalEscape

quotedEscape	back to summary
private final String quotedEscape

stringEscape	back to summary
private final String stringEscape

SYMBOLS_AND_WS	back to summary
private static final String SYMBOLS_AND_WS

Constructor Detail

HighlightingFormatter	back to summary
public HighlightingFormatter(String keywordCode, String stringCode, String quotedCode) Parameters keywordCode:String the ANSI escape code to use for highlighting SQL keywords stringCode:String the ANSI escape code to use for highlighting SQL strings

Method Detail

escape	back to summary
private static String escape(String code)

format

back to summary

public String format(String sql)

Implements org.hibernate.engine.jdbc.internal.Formatter.format.

Doc from org.hibernate.engine.jdbc.internal.Formatter.format.

Format the source SQL string.

Parameters

sql:String: The original SQL string

Returns:String

The formatted version

Annotations

@Override