JSQLFormatter Java API SNAPSHOT¶
Base Package: com.manticore.jsqlformatter
Package com.manticore.jsqlformatter¶
Classes¶
Class |
Description |
|---|---|
A powerful Java SQL Formatter based on the JSQLParser. |
|
Enums¶
Enum |
Description |
|---|---|
Class Comment¶
Package: com.manticore.jsqlformatter
public class Comment implements Comparable<Comment>
Field Summary¶
Modifier and Type |
Field |
|---|---|
protected boolean |
|
protected boolean |
|
protected int |
|
protected int |
|
protected String |
Field Detail¶
newLine¶
protected boolean newLine
extraNewLine¶
protected boolean extraNewLine
absolutePosition¶
protected int absolutePosition
relativePosition¶
protected int relativePosition
text¶
protected String text
Constructor Summary¶
Constructor |
|---|
Constructor Detail¶
Comment¶
public Comment(int absolutePosition, String text)
Method Summary¶
Modifier and Type |
Method |
|---|---|
public int |
|
public String |
Method Detail¶
compareTo¶
public int compareTo(Comment o)
Parameters
o — Comment
Returns
int
toString¶
public String toString()
Returns
Class CommentMap¶
Package: com.manticore.jsqlformatter
public class CommentMap extends java.util.LinkedHashMap<Integer, Comment>
Field Summary¶
Modifier and Type |
Field |
|---|---|
public static final java.util.regex.Pattern |
|
public static final java.util.regex.Pattern |
Field Detail¶
COMMENT_PATTERN¶
public static final java.util.regex.Pattern COMMENT_PATTERN
LINE_END_COMMENT_PATTERN¶
public static final java.util.regex.Pattern LINE_END_COMMENT_PATTERN
Constructor Summary¶
Constructor |
|---|
Constructor Detail¶
CommentMap¶
public CommentMap(String sqlStr)
Parameters
sqlStr — String
Method Summary¶
Modifier and Type |
Method |
|---|---|
public StringBuilder |
|
public int |
Method Detail¶
insertComments¶
public StringBuilder insertComments(StringBuilder sqlStrWithoutComments, OutputFormat outputFormat)
Returns
getLength¶
public int getLength()
Returns
int
Class JSQLFormatter¶
Package: com.manticore.jsqlformatter
public class JSQLFormatter
A powerful Java SQL Formatter based on the JSQLParser.
Field Summary¶
Modifier and Type |
Field |
|---|---|
public static final java.util.regex.Pattern |
|
public static final com.diogonunes.jcolor.AnsiFormat |
|
public static final com.diogonunes.jcolor.AnsiFormat |
|
public static final com.diogonunes.jcolor.AnsiFormat |
|
public static final com.diogonunes.jcolor.AnsiFormat |
|
public static final com.diogonunes.jcolor.AnsiFormat |
|
public static final com.diogonunes.jcolor.AnsiFormat |
|
public static final com.diogonunes.jcolor.AnsiFormat |
|
public static final com.diogonunes.jcolor.AnsiFormat |
Field Detail¶
SQUARED_BRACKET_QUOTATION_PATTERN¶
public static final java.util.regex.Pattern SQUARED_BRACKET_QUOTATION_PATTERN
ANSI_FORMAT_LINE_NUMBER¶
public static final com.diogonunes.jcolor.AnsiFormat ANSI_FORMAT_LINE_NUMBER
ANSI_FORMAT_KEYWORD¶
public static final com.diogonunes.jcolor.AnsiFormat ANSI_FORMAT_KEYWORD
ANSI_FORMAT_HINT¶
public static final com.diogonunes.jcolor.AnsiFormat ANSI_FORMAT_HINT
ANSI_FORMAT_OPERATOR¶
public static final com.diogonunes.jcolor.AnsiFormat ANSI_FORMAT_OPERATOR
ANSI_FORMAT_PARAMETER¶
public static final com.diogonunes.jcolor.AnsiFormat ANSI_FORMAT_PARAMETER
ANSI_FORMAT_ALIAS¶
public static final com.diogonunes.jcolor.AnsiFormat ANSI_FORMAT_ALIAS
ANSI_FORMAT_FUNCTION¶
public static final com.diogonunes.jcolor.AnsiFormat ANSI_FORMAT_FUNCTION
ANSI_FORMAT_TYPE¶
public static final com.diogonunes.jcolor.AnsiFormat ANSI_FORMAT_TYPE
Constructor Summary¶
Constructor |
|---|
Constructor Detail¶
JSQLFormatter¶
public JSQLFormatter()
Method Summary¶
Modifier and Type |
Method |
|---|---|
public static SquaredBracketQuotation |
|
public static void |
|
public static BackSlashQuoting |
|
public static void |
|
public static StatementTerminator |
|
public static void |
|
public static Separation |
|
public static void |
|
public static Spelling |
|
public static void |
|
public static Spelling |
|
public static void |
|
public static Spelling |
|
public static void |
|
public static OutputFormat |
|
public static void |
|
public static int |
|
public static void |
|
public static String |
|
public static void |
|
public static java.io.File |
|
public static String |
|
public static java.util.ArrayList<Exception> |
|
public static String |
|
public static StringBuilder |
|
public static void |
|
public static void |
|
public static void |
|
public static void |
|
public static void |
Method Detail¶
getSquaredBracketQuotation¶
public static SquaredBracketQuotation getSquaredBracketQuotation()
Returns
setSquaredBracketQuotation¶
public static void setSquaredBracketQuotation(SquaredBracketQuotation squaredBracketQuotation)
Parameters
squaredBracketQuotation — SquaredBracketQuotation
getBackSlashQuoting¶
public static BackSlashQuoting getBackSlashQuoting()
Returns
setBackSlashQuoting¶
public static void setBackSlashQuoting(BackSlashQuoting backSlashQuoting)
Parameters
backSlashQuoting — BackSlashQuoting
getStatementTerminator¶
public static StatementTerminator getStatementTerminator()
Returns
setStatementTerminator¶
public static void setStatementTerminator(StatementTerminator statementTerminator)
Parameters
statementTerminator — StatementTerminator
getSeparation¶
public static Separation getSeparation()
Returns
setSeparation¶
public static void setSeparation(Separation separation)
Parameters
separation — Separation
getKeywordSpelling¶
public static Spelling getKeywordSpelling()
Returns
setKeywordSpelling¶
public static void setKeywordSpelling(Spelling keywordSpelling)
Parameters
keywordSpelling — Spelling
getFunctionSpelling¶
public static Spelling getFunctionSpelling()
Returns
setFunctionSpelling¶
public static void setFunctionSpelling(Spelling functionSpelling)
Parameters
functionSpelling — Spelling
getObjectSpelling¶
public static Spelling getObjectSpelling()
Returns
setObjectSpelling¶
public static void setObjectSpelling(Spelling objectSpelling)
Parameters
objectSpelling — Spelling
getOutputFormat¶
public static OutputFormat getOutputFormat()
Returns
setOutputFormat¶
public static void setOutputFormat(OutputFormat outputFormat)
Parameters
outputFormat — OutputFormat
getIndentWidth¶
public static int getIndentWidth()
Returns
int
setIndentWidth¶
public static void setIndentWidth(int indentWidth)
Parameters
indentWidth — int
getIndentString¶
public static String getIndentString()
Returns
setIndentString¶
public static void setIndentString(String indentString)
Parameters
indentString — String
getAbsoluteFile¶
public static java.io.File getAbsoluteFile(String filename)
Parameters
filename — String
Returns
getAbsoluteFileName¶
public static String getAbsoluteFileName(String filename)
Parameters
filename — String
Returns
verify¶
public static java.util.ArrayList<Exception> verify(String sqlStr, String[][] options)
Returns
format¶
public static String format(String sqlStr, String[][] options) throws Exception
Returns
Throws
formatToJava¶
public static StringBuilder formatToJava(String sqlStr, int indent, String[][] options) throws Exception
Returns
Throws
applyFormattingOptions¶
public static void applyFormattingOptions(String[][] options)
Parameters
options — String[][]
appendMergeUpdate¶
public static void appendMergeUpdate(net.sf.jsqlparser.statement.merge.MergeUpdate update, StringBuilder builder, int indent)
Parameters
update — net.sf.jsqlparser.statement.merge.MergeUpdate
builder — StringBuilder
indent — int
appendMergeInsert¶
public static void appendMergeInsert(net.sf.jsqlparser.statement.merge.MergeInsert insert, StringBuilder builder, int indent, int i)
Parameters
insert — net.sf.jsqlparser.statement.merge.MergeInsert
builder — StringBuilder
indent — int
i — int
appendSelectItemList¶
public static void appendSelectItemList(java.util.List<net.sf.jsqlparser.statement.select.SelectItem<?>> selectItems, StringBuilder builder, int subIndent, int i, BreakLine bl, int indent) throws UnsupportedOperationException
Parameters
selectItems — java.util.List<net.sf.jsqlparser.statement.select.SelectItem<?>>
builder — StringBuilder
subIndent — int
i — int
bl — BreakLine
indent — int
appendColumnSelectItemList¶
public static void appendColumnSelectItemList(java.util.List<net.sf.jsqlparser.statement.select.SelectItem<net.sf.jsqlparser.schema.Column>> selectItems, StringBuilder builder, int subIndent, int i, BreakLine bl, int indent) throws UnsupportedOperationException
Parameters
selectItems — java.util.List<net.sf.jsqlparser.statement.select.SelectItem<net.sf.jsqlparser.schema.Column>>
builder — StringBuilder
subIndent — int
i — int
bl — BreakLine
indent — int
Class BuildInfo¶
Package: com.manticore.jsqlformatter
public class BuildInfo
Field Summary¶
Modifier and Type |
Field |
|---|---|
public static final String |
|
public static final String |
|
public static final String |
|
public static final String |
Field Detail¶
NAME¶
public static final String NAME = JSQLFormatter
VERSION¶
public static final String VERSION = 5.3-4-gd9d1c68-SNAPSHOT
GIT_COMMIT¶
public static final String GIT_COMMIT = d9d1c68
BUILD_TIME¶
public static final String BUILD_TIME = 2025-11-24T00:46:59.900276365Z
Constructor Summary¶
Constructor |
|---|
Constructor Detail¶
BuildInfo¶
public BuildInfo()
Enum FormattingOption¶
Package: com.manticore.jsqlformatter.JSQLFormatter
public enum FormattingOption
Enum Constants¶
Enum Constant |
|---|
Enum Constant Detail¶
SQUARE_BRACKET_QUOTATION¶
public static final FormattingOption SQUARE_BRACKET_QUOTATION
BACKSLASH_QUOTING¶
public static final FormattingOption BACKSLASH_QUOTING
OUTPUT_FORMAT¶
public static final FormattingOption OUTPUT_FORMAT
KEYWORD_SPELLING¶
public static final FormattingOption KEYWORD_SPELLING
FUNCTION_SPELLING¶
public static final FormattingOption FUNCTION_SPELLING
OBJECT_SPELLING¶
public static final FormattingOption OBJECT_SPELLING
SEPARATION¶
public static final FormattingOption SEPARATION
INDENT_WIDTH¶
public static final FormattingOption INDENT_WIDTH
SHOW_LINE_NUMBERS¶
public static final FormattingOption SHOW_LINE_NUMBERS
STATEMENT_TERMINATOR¶
public static final FormattingOption STATEMENT_TERMINATOR
Enum StatementTerminator¶
Package: com.manticore.jsqlformatter.JSQLFormatter
public enum StatementTerminator
Enum Constants¶
Enum Constant |
|---|
Enum Constant Detail¶
SEMICOLON¶
public static final StatementTerminator SEMICOLON
NONE¶
public static final StatementTerminator NONE
GO¶
public static final StatementTerminator GO
BACKSLASH¶
public static final StatementTerminator BACKSLASH
Enum BackSlashQuoting¶
Package: com.manticore.jsqlformatter.JSQLFormatter
public enum BackSlashQuoting
Enum Constants¶
Enum Constant |
|---|
Enum Constant Detail¶
YES¶
public static final BackSlashQuoting YES
NO¶
public static final BackSlashQuoting NO
Enum ShowLineNumbers¶
Package: com.manticore.jsqlformatter.JSQLFormatter
public enum ShowLineNumbers
Enum Constants¶
Enum Constant |
|---|
Enum Constant Detail¶
YES¶
public static final ShowLineNumbers YES
NO¶
public static final ShowLineNumbers NO
Enum SquaredBracketQuotation¶
Package: com.manticore.jsqlformatter.JSQLFormatter
public enum SquaredBracketQuotation
Enum Constants¶
Enum Constant |
|---|
Enum Constant Detail¶
AUTO¶
public static final SquaredBracketQuotation AUTO
YES¶
public static final SquaredBracketQuotation YES
NO¶
public static final SquaredBracketQuotation NO
Enum BreakLine¶
Package: com.manticore.jsqlformatter.JSQLFormatter
public enum BreakLine
Enum Constants¶
Enum Constant |
|---|
Enum Constant Detail¶
NEVER¶
public static final BreakLine NEVER
AS_NEEDED¶
public static final BreakLine AS_NEEDED
AFTER_FIRST¶
public static final BreakLine AFTER_FIRST
ALWAYS¶
public static final BreakLine ALWAYS
Enum Separation¶
Package: com.manticore.jsqlformatter.JSQLFormatter
public enum Separation
Enum Constants¶
Enum Constant |
|---|
Enum Constant Detail¶
BEFORE¶
public static final Separation BEFORE
AFTER¶
public static final Separation AFTER
Enum Spelling¶
Package: com.manticore.jsqlformatter.JSQLFormatter
public enum Spelling
Enum Constants¶
Enum Constant |
|---|
Enum Constant Detail¶
UPPER¶
public static final Spelling UPPER
LOWER¶
public static final Spelling LOWER
CAMEL¶
public static final Spelling CAMEL
KEEP¶
public static final Spelling KEEP
Enum OutputFormat¶
Package: com.manticore.jsqlformatter.JSQLFormatter
public enum OutputFormat
Enum Constants¶
Enum Constant |
|---|
Enum Constant Detail¶
PLAIN¶
public static final OutputFormat PLAIN
ANSI¶
public static final OutputFormat ANSI
HTML¶
public static final OutputFormat HTML
RTF¶
public static final OutputFormat RTF
XSLFO¶
public static final OutputFormat XSLFO