API 5.1-SNAPSHOT

Base Package: com.manticore.jsqlformatter

Base

BackSlashQuoting

[YES, NO]

BreakLine

[NEVER, AS_NEEDED, AFTER_FIRST, ALWAYS]

FormattingOption

[SQUARE_BRACKET_QUOTATION, BACKSLASH_QUOTING, OUTPUT_FORMAT, KEYWORD_SPELLING, FUNCTION_SPELLING, OBJECT_SPELLING, SEPARATION, INDENT_WIDTH, SHOW_LINE_NUMBERS, STATEMENT_TERMINATOR]

OutputFormat

[PLAIN, ANSI, HTML, RTF, XSLFO]

Separation

[BEFORE, AFTER]

ShowLineNumbers

[YES, NO]

Spelling

[UPPER, LOWER, CAMEL, KEEP]

SquaredBracketQuotation

[AUTO, YES, NO]

StatementTerminator

[SEMICOLON, NONE, GO, BACKSLASH]

Comment

extends: Object implements: Comment>

Comment (absolutePosition, text)

int absolutePosition

String text

@Override

compareTo (o) → int

Comment o

returns int

@Override

toString () → String

returns String

CommentMap

extends: Comment>

CommentMap (sqlStr)

String sqlStr

StringBuilder builder

OutputFormat format

String keyword

String before

String after

returns StringBuilder

@SuppressWarnings

insertComments (sqlStrWithoutComments, outputFormat) → StringBuilder

StringBuilder sqlStrWithoutComments

OutputFormat outputFormat

returns StringBuilder

getLength () → int

returns int

JSQLFormatter

extends: Object

A powerful Java SQL Formatter based on the JSQLParser.

JSQLFormatter ()

getSquaredBracketQuotation () → SquaredBracketQuotation

returns SquaredBracketQuotation

setSquaredBracketQuotation (squaredBracketQuotation)

SquaredBracketQuotation squaredBracketQuotation

getBackSlashQuoting () → BackSlashQuoting

returns BackSlashQuoting

setBackSlashQuoting (backSlashQuoting)

BackSlashQuoting backSlashQuoting

getStatementTerminator () → StatementTerminator

returns StatementTerminator

setStatementTerminator (statementTerminator)

StatementTerminator statementTerminator

getSeparation () → Separation

returns Separation

setSeparation (separation)

Separation separation

getKeywordSpelling () → Spelling

returns Spelling

setKeywordSpelling (keywordSpelling)

Spelling keywordSpelling

getFunctionSpelling () → Spelling

returns Spelling

setFunctionSpelling (functionSpelling)

Spelling functionSpelling

getObjectSpelling () → Spelling

returns Spelling

setObjectSpelling (objectSpelling)

Spelling objectSpelling

getOutputFormat () → OutputFormat

returns OutputFormat

setOutputFormat (outputFormat)

OutputFormat outputFormat

getIndentWidth () → int

returns int

setIndentWidth (indentWidth)

int indentWidth

getIndentString () → String

returns String

setIndentString (indentString)

String indentString

ExpressionList parameters

BreakLine breakLine

StringBuilder builder

int indent

returns void

String s

returns String

StringBuilder builder

OutputFormat format

String keyword

String before

String after

returns StringBuilder

StringBuilder builder

String s

returns StringBuilder

StringBuilder builder

returns StringBuilder

StringBuilder builder

OutputFormat format

String hint

String before

String after

returns StringBuilder

StringBuilder builder

OutputFormat format

String operator

String before

String after

returns StringBuilder

StringBuilder builder

OutputFormat format

String value

String before

String after

returns StringBuilder

StringBuilder builder

OutputFormat format

String alias

String before

String after

returns StringBuilder

StringBuilder builder

OutputFormat format

String objectName

String before

String after

returns StringBuilder

StringBuilder builder

OutputFormat format

String function

String before

String after

returns StringBuilder

StringBuilder builder

OutputFormat format

String type

String before

String after

returns StringBuilder

StringBuilder builder

returns int

StringBuilder builder

boolean moveToTab

returns int

StringBuilder builder

Delete delete

int indent

returns void

PMD.CyclomaticComplexity

getAbsoluteFile (filename) → File

String filename

returns File

getAbsoluteFileName (filename) → String

String filename

returns String

@SuppressWarnings

verify (sqlStr, options) → Exception>

String sqlStr

String[] options

returns Exception>

@SuppressWarnings

format (sqlStr, options) → String

String sqlStr

String[] options

returns String

formatToJava (sqlStr, indent, options) → StringBuilder

String sqlStr

int indent

String[] options

returns StringBuilder

@SuppressWarnings

applyFormattingOptions (options)

String[] options

StringBuilder builder

Merge merge

int indent

returns void

OutputClause outputClause

StringBuilder builder

int indent

returns void

appendMergeUpdate (update, builder, indent)

MergeUpdate update

StringBuilder builder

int indent

@SuppressWarnings

appendMergeInsert (insert, builder, indent, i)

MergeInsert insert

StringBuilder builder

int indent

int i

StringBuilder builder

Insert insert

int indent

returns void

StringBuilder builder

Update update

int indent

returns void

StringBuilder builder

UpdateSet> updateSets

int subIndent

returns void

Select select

StringBuilder builder

int indent

boolean breakLineBefore

boolean indentFirstLine

returns void

PMD.CyclomaticComplexity PMD.ExcessiveMethodLength

appendSelectItemList (selectItems, builder, subIndent, i, bl, indent)

SelectItem selectItems

StringBuilder builder

int subIndent

int i

BreakLine bl

int indent

appendColumnSelectItemList (selectItems, builder, subIndent, i, bl, indent)

Column>> selectItems

StringBuilder builder

int subIndent

int i

BreakLine bl

int indent

OrderByElement> orderByElements

StringBuilder builder

int indent

returns void

PMD.CyclomaticComplexity

Expression havingExpression

StringBuilder builder

int indent

returns void

GroupByElement groupByElement

StringBuilder builder

int indent

returns void

PMD.CyclomaticComplexity

Expression whereExpression

StringBuilder builder

int indent

returns void

Join> joins

StringBuilder builder

int indent

returns void

PMD.CyclomaticComplexity

WithItem withItem

StringBuilder builder

int indent

int i

int n

returns void

PMD.CyclomaticComplexity

StringBuilder builder

int indent

RowConstructor rowConstructor

returns void

String> strings

StringBuilder builder

int indent

boolean commaSeparated

BreakLine breakLine

returns void

String s

StringBuilder builder

int indent

int i

int n

boolean commaSeparated

BreakLine breakLine

returns void

PMD.CyclomaticComplexity

Expression expression

Alias alias

StringBuilder builder

int indent

int i

int n

boolean commaSeparated

BreakLine breakLine

returns void

PMD.CyclomaticComplexity PMD.ExcessiveMethodLength

ExpressionList expressionList

StringBuilder builder

int indent

BreakLine breakLine

returns void

Expression> expressions

StringBuilder builder

int indent

BreakLine breakLine

returns void

FromItem fromItem

StringBuilder builder

int indent

int i

int n

returns void

PMD.CyclomaticComplexity

Table table

Alias alias

StringBuilder builder

returns void

SetOperation setOperation

StringBuilder builder

int indent

returns void

PMD.CyclomaticComplexity

StringBuilder builder

Truncate truncate

returns void

StringBuilder builder

CreateTable createTable

int indent

returns void

PMD.CyclomaticComplexity PMD.ExcessiveMethodLength

StringBuilder builder

CreateIndex createIndex

int indent

returns void

PMD.CyclomaticComplexity

StringBuilder builder

CreateView createView

int indent

returns void

StringBuilder builder

Alter alter

int indent

returns void

PMD.CyclomaticComplexity PMD.ExcessiveMethodLength