API Reference Test¶

Package com.manticore.jsqlformatter¶

Enums¶

Enum	Description
FormattingOption
StatementTerminator
BackSlashQuoting
ShowLineNumbers
SquaredBracketQuotation
BreakLine
Separation
Spelling
OutputFormat

Classes¶

Classe	Description
Comment
CommentMap
JSQLFormatter	A powerful Java SQL Formatter based on the JSQLParser.

Class Comment¶

Package: com.manticore.jsqlformatter

public class Comment implements Comparable<Comment>

@author: are

Field Summary¶

Modifier and Type	Field	Description
protected boolean	newLine
protected boolean	extraNewLine
protected int	absolutePosition
protected int	relativePosition
protected String	text

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	Description
Comment(int absolutePosition, String text)

Constructor Detail¶

Comment

public Comment(int absolutePosition, java.lang.String text)

Parameters:

absolutePosition — int
text — java.lang.String

Method Summary¶

Modifier and Type	Method	Description
public int	compareTo(Comment o)
public String	toString()

Method Detail¶

compareTo

public int compareTo(Comment o)

Parameters:

o — Comment

Returns: int

toString

public java.lang.String toString()

Returns: java.lang.String

Class CommentMap¶

Package: com.manticore.jsqlformatter

public class CommentMap extends LinkedHashMap<Integer, Comment>

@author: are

Field Summary¶

Modifier and Type	Field	Description
public static final Pattern	COMMENT_PATTERN
public static final Pattern	LINE_END_COMMENT_PATTERN

Field Detail¶

COMMENT_PATTERN

public static final Pattern COMMENT_PATTERN

LINE_END_COMMENT_PATTERN

public static final Pattern LINE_END_COMMENT_PATTERN

Constructor Summary¶

Constructor	Description
CommentMap(String sqlStr)

Constructor Detail¶

CommentMap

public CommentMap(java.lang.String sqlStr)

Parameters:

sqlStr — java.lang.String

Method Summary¶

Modifier and Type	Method	Description
public StringBuilder	insertComments(StringBuilder sqlStrWithoutComments, OutputFormat outputFormat)
public int	getLength()

Method Detail¶

insertComments

public java.lang.StringBuilder insertComments(java.lang.StringBuilder sqlStrWithoutComments, JSQLFormatter.OutputFormat outputFormat)

Parameters:

sqlStrWithoutComments — java.lang.StringBuilder
outputFormat — JSQLFormatter.OutputFormat

Returns: java.lang.StringBuilder

getLength

public int getLength()

Returns: int

Class JSQLFormatter¶

Package: com.manticore.jsqlformatter

public class JSQLFormatter

A powerful Java SQL Formatter based on the JSQLParser.

@author: <a href=”mailto:andreas@manticore-projects.com”>Andreas Reichel</a>
@version: 0.1

Field Summary¶

Modifier and Type	Field	Description
public static final Pattern	SQUARED_BRACKET_QUOTATION_PATTERN
public static final AnsiFormat	ANSI_FORMAT_LINE_NUMBER
public static final AnsiFormat	ANSI_FORMAT_KEYWORD
public static final AnsiFormat	ANSI_FORMAT_HINT
public static final AnsiFormat	ANSI_FORMAT_OPERATOR
public static final AnsiFormat	ANSI_FORMAT_PARAMETER
public static final AnsiFormat	ANSI_FORMAT_ALIAS
public static final AnsiFormat	ANSI_FORMAT_FUNCTION
public static final AnsiFormat	ANSI_FORMAT_TYPE

Field Detail¶

SQUARED_BRACKET_QUOTATION_PATTERN

public static final Pattern SQUARED_BRACKET_QUOTATION_PATTERN

ANSI_FORMAT_LINE_NUMBER

public static final AnsiFormat ANSI_FORMAT_LINE_NUMBER

ANSI_FORMAT_KEYWORD

public static final AnsiFormat ANSI_FORMAT_KEYWORD

ANSI_FORMAT_HINT

public static final AnsiFormat ANSI_FORMAT_HINT

ANSI_FORMAT_OPERATOR

public static final AnsiFormat ANSI_FORMAT_OPERATOR

ANSI_FORMAT_PARAMETER

public static final AnsiFormat ANSI_FORMAT_PARAMETER

ANSI_FORMAT_ALIAS

public static final AnsiFormat ANSI_FORMAT_ALIAS

ANSI_FORMAT_FUNCTION

public static final AnsiFormat ANSI_FORMAT_FUNCTION

ANSI_FORMAT_TYPE

public static final AnsiFormat ANSI_FORMAT_TYPE

Constructor Summary¶

Constructor	Description
JSQLFormatter()

Constructor Detail¶

JSQLFormatter

public JSQLFormatter()

Method Summary¶

Modifier and Type	Method	Description
public static SquaredBracketQuotation	getSquaredBracketQuotation()
public static void	setSquaredBracketQuotation(SquaredBracketQuotation squaredBracketQuotation)
public static BackSlashQuoting	getBackSlashQuoting()
public static void	setBackSlashQuoting(BackSlashQuoting backSlashQuoting)
public static StatementTerminator	getStatementTerminator()
public static void	setStatementTerminator(StatementTerminator statementTerminator)
public static Separation	getSeparation()
public static void	setSeparation(Separation separation)
public static Spelling	getKeywordSpelling()
public static void	setKeywordSpelling(Spelling keywordSpelling)
public static Spelling	getFunctionSpelling()
public static void	setFunctionSpelling(Spelling functionSpelling)
public static Spelling	getObjectSpelling()
public static void	setObjectSpelling(Spelling objectSpelling)
public static OutputFormat	getOutputFormat()
public static void	setOutputFormat(OutputFormat outputFormat)
public static int	getIndentWidth()
public static void	setIndentWidth(int indentWidth)
public static String	getIndentString()
public static void	setIndentString(String indentString)
public static File	getAbsoluteFile(String filename)
public static String	getAbsoluteFileName(String filename)
public static ArrayList	verify(String sqlStr, String[][] options)
public static String	format(String sqlStr, String[][] options)
public static StringBuilder	formatToJava(String sqlStr, int indent, String[][] options)
public static void	applyFormattingOptions(String[][] options)
public static void	appendMergeUpdate(MergeUpdate update, StringBuilder builder, int indent)
public static void	appendMergeInsert(MergeInsert insert, StringBuilder builder, int indent, int i)
public static void	appendSelectItemList(List<SelectItem<?>> selectItems, StringBuilder builder, int subIndent, int i, BreakLine bl, int indent)
public static void	appendColumnSelectItemList(List<SelectItem<Column>> selectItems, StringBuilder builder, int subIndent, int i, BreakLine bl, int indent)

Method Detail¶

getSquaredBracketQuotation

public static JSQLFormatter.SquaredBracketQuotation getSquaredBracketQuotation()

Returns: JSQLFormatter.SquaredBracketQuotation

setSquaredBracketQuotation

public static void setSquaredBracketQuotation(JSQLFormatter.SquaredBracketQuotation squaredBracketQuotation)

Parameters:

squaredBracketQuotation — JSQLFormatter.SquaredBracketQuotation

getBackSlashQuoting

public static JSQLFormatter.BackSlashQuoting getBackSlashQuoting()

Returns: JSQLFormatter.BackSlashQuoting

setBackSlashQuoting

public static void setBackSlashQuoting(JSQLFormatter.BackSlashQuoting backSlashQuoting)

Parameters:

backSlashQuoting — JSQLFormatter.BackSlashQuoting

getStatementTerminator

public static JSQLFormatter.StatementTerminator getStatementTerminator()

Returns: JSQLFormatter.StatementTerminator

setStatementTerminator

public static void setStatementTerminator(JSQLFormatter.StatementTerminator statementTerminator)

Parameters:

statementTerminator — JSQLFormatter.StatementTerminator

getSeparation

public static JSQLFormatter.Separation getSeparation()

Returns: JSQLFormatter.Separation

setSeparation

public static void setSeparation(JSQLFormatter.Separation separation)

Parameters:

separation — JSQLFormatter.Separation

getKeywordSpelling

public static JSQLFormatter.Spelling getKeywordSpelling()

Returns: JSQLFormatter.Spelling

setKeywordSpelling

public static void setKeywordSpelling(JSQLFormatter.Spelling keywordSpelling)

Parameters:

keywordSpelling — JSQLFormatter.Spelling

getFunctionSpelling

public static JSQLFormatter.Spelling getFunctionSpelling()

Returns: JSQLFormatter.Spelling

setFunctionSpelling

public static void setFunctionSpelling(JSQLFormatter.Spelling functionSpelling)

Parameters:

functionSpelling — JSQLFormatter.Spelling

getObjectSpelling

public static JSQLFormatter.Spelling getObjectSpelling()

Returns: JSQLFormatter.Spelling

setObjectSpelling

public static void setObjectSpelling(JSQLFormatter.Spelling objectSpelling)

Parameters:

objectSpelling — JSQLFormatter.Spelling

getOutputFormat

public static JSQLFormatter.OutputFormat getOutputFormat()

Returns: JSQLFormatter.OutputFormat

setOutputFormat

public static void setOutputFormat(JSQLFormatter.OutputFormat outputFormat)

Parameters:

outputFormat — JSQLFormatter.OutputFormat

getIndentWidth

public static int getIndentWidth()

Returns: int

setIndentWidth

public static void setIndentWidth(int indentWidth)

Parameters:

indentWidth — int

getIndentString

public static java.lang.String getIndentString()

Returns: java.lang.String

setIndentString

public static void setIndentString(java.lang.String indentString)

Parameters:

indentString — java.lang.String

getAbsoluteFile

public static java.io.File getAbsoluteFile(java.lang.String filename)

Parameters:

filename — java.lang.String

Returns: java.io.File

getAbsoluteFileName

public static java.lang.String getAbsoluteFileName(java.lang.String filename)

Parameters:

filename — java.lang.String

Returns: java.lang.String

verify

public static java.util.ArrayList verify(java.lang.String sqlStr, java.lang.String[][] options)

Parameters:

sqlStr — java.lang.String
options — java.lang.String[][]

Returns: java.util.ArrayList

format

public static java.lang.String format(java.lang.String sqlStr, java.lang.String[][] options)

Parameters:

sqlStr — java.lang.String
options — java.lang.String[][]

Returns: java.lang.String

formatToJava

public static java.lang.StringBuilder formatToJava(java.lang.String sqlStr, int indent, java.lang.String[][] options)

Parameters:

sqlStr — java.lang.String
indent — int
options — java.lang.String[][]

Returns: java.lang.StringBuilder

applyFormattingOptions

public static void applyFormattingOptions(java.lang.String[][] options)

Parameters:

options — java.lang.String[][]

appendMergeUpdate

public static void appendMergeUpdate(net.sf.jsqlparser.statement.merge.MergeUpdate update, java.lang.StringBuilder builder, int indent)

Parameters:

update — net.sf.jsqlparser.statement.merge.MergeUpdate
builder — java.lang.StringBuilder
indent — int

appendMergeInsert

public static void appendMergeInsert(net.sf.jsqlparser.statement.merge.MergeInsert insert, java.lang.StringBuilder builder, int indent, int i)

Parameters:

insert — net.sf.jsqlparser.statement.merge.MergeInsert
builder — java.lang.StringBuilder
indent — int
i — int

appendSelectItemList

public static void appendSelectItemList(java.util.List<net.sf.jsqlparser.statement.select.SelectItem<?>> selectItems, java.lang.StringBuilder builder, int subIndent, int i, JSQLFormatter.BreakLine bl, int indent)

Parameters:

selectItems — java.util.List<net.sf.jsqlparser.statement.select.SelectItem<?>>
builder — java.lang.StringBuilder
subIndent — int
i — int
bl — JSQLFormatter.BreakLine
indent — int

appendColumnSelectItemList

public static void appendColumnSelectItemList(java.util.List<net.sf.jsqlparser.statement.select.SelectItem<net.sf.jsqlparser.schema.Column>> selectItems, java.lang.StringBuilder builder, int subIndent, int i, JSQLFormatter.BreakLine bl, int indent)

Parameters:

selectItems — java.util.List<net.sf.jsqlparser.statement.select.SelectItem<net.sf.jsqlparser.schema.Column>>
builder — java.lang.StringBuilder
subIndent — int
i — int
bl — JSQLFormatter.BreakLine
indent — int

Enum FormattingOption¶

Package: com.manticore.jsqlformatter.JSQLFormatter

public enum FormattingOption

Enum Constants¶

Constant	Description
SQUARE_BRACKET_QUOTATION
BACKSLASH_QUOTING
OUTPUT_FORMAT
KEYWORD_SPELLING
FUNCTION_SPELLING
OBJECT_SPELLING
SEPARATION
INDENT_WIDTH
SHOW_LINE_NUMBERS
STATEMENT_TERMINATOR

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¶

Constant	Description
SEMICOLON
NONE
GO
BACKSLASH

Enum Constant Detail¶

SEMICOLON

public static final StatementTerminator SEMICOLON

NONE

public static final StatementTerminator NONE

public static final StatementTerminator GO

BACKSLASH

public static final StatementTerminator BACKSLASH

Enum BackSlashQuoting¶

Package: com.manticore.jsqlformatter.JSQLFormatter

public enum BackSlashQuoting

Enum Constants¶

Constant	Description
YES
NO

Enum Constant Detail¶

YES

public static final BackSlashQuoting YES

public static final BackSlashQuoting NO

Enum ShowLineNumbers¶

Package: com.manticore.jsqlformatter.JSQLFormatter

public enum ShowLineNumbers

Enum Constants¶

Constant	Description
YES
NO

Enum Constant Detail¶

YES

public static final ShowLineNumbers YES

public static final ShowLineNumbers NO

Enum SquaredBracketQuotation¶

Package: com.manticore.jsqlformatter.JSQLFormatter

public enum SquaredBracketQuotation

Enum Constants¶

Constant	Description
AUTO
YES
NO

Enum Constant Detail¶

AUTO

public static final SquaredBracketQuotation AUTO

YES

public static final SquaredBracketQuotation YES

public static final SquaredBracketQuotation NO

Enum BreakLine¶

Package: com.manticore.jsqlformatter.JSQLFormatter

public enum BreakLine

Enum Constants¶

Constant	Description
NEVER
AS_NEEDED
AFTER_FIRST
ALWAYS

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¶

Constant	Description
BEFORE
AFTER

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¶

Constant	Description
UPPER
LOWER
CAMEL
KEEP

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¶

Constant	Description
PLAIN
ANSI
HTML
RTF
XSLFO

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