GFmtOpt (General SQL Parser Java Library Core 3.0.9.1 API)

Object
- gudusoft.gsqlparser.pp.para.GFmtOpt

```
public class GFmtOpt
extends Object
```
the format options

Author:

zhoujun

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`alignAliasInSelectList` //todo add sample4
`boolean`	`alignJoinWithFromKeyword` align 'join' keyword with 'from' keyword //todo add sample10
`boolean`	`andOrUnderWhere` in the where clause, the 'and' and 'or' keyword should under the 'where' keyword //todo add sample11
`Integer`	`beStyleBlockIndentSize` //todo add sample26
`Integer`	`beStyleBlockLeftBEIndentSize` //todo add sample24
`Boolean`	`beStyleBlockLeftBEOnNewline` //todo add sample23
`Integer`	`beStyleBlockRightBEIndentSize` //todo add sample25
`boolean`	`beStyleCreatetableLeftBEOnNewline` //todo add sample14
`boolean`	`beStyleCreatetableRightBEOnNewline` //todo add sample15
`Integer`	`beStyleFunctionBodyIndent`
`Boolean`	`beStyleFunctionFirstParamInNewline` //todo add sample51
`Integer`	`beStyleFunctionLeftBEIndentSize` //todo add sample48
`Boolean`	`beStyleFunctionLeftBEOnNewline` //todo add sample47
`Integer`	`beStyleFunctionRightBEIndentSize` //todo add sample50
`Boolean`	`beStyleFunctionRightBEOnNewline` //todo add sample49
`Integer`	`beStyleIfElseSingleStmtIndentSize` //todo add sample27
`TCaseOption`	`caseDatatype` //todo add sample36
`TCaseOption`	`caseFuncname` //todo add sample35
`TCaseOption`	`caseIdentifier` //todo add sample33
`TCaseOption`	`caseKeywords` //todo add sample32
`TCaseOption`	`caseQuotedIdentifier` //todo add sample34
`Boolean`	`caseWhenThenInSameLine` //todo add sample28
`TCompactMode`	`compactMode` //todo add sample63
`TAlignOption`	`createtableFieldlistAlignOption` //todo add sample17
`boolean`	`createtableListitemInNewLine` //todo add sample16
`Boolean`	`cteNewlineBeforeAs` //todo add sample43
`TAlignStyle`	`defaultAligntype` //todo add sample19
`TLinefeedsCommaOption`	`defaultCommaOption` //todo add sample18
`TEmptyLinesOption`	`emptyLines` //todo add sample53
`boolean`	`fromClauseInNewLine` each column in the table names in the form clause should start with a new line.
`TLinefeedsCommaOption`	`functionCallParametersComma` //todo add sample61
`TAlignStyle`	`functionCallParametersStyle` //todo add sample60
`Integer`	`indentCaseFromSwitch` //todo add sample29
`Integer`	`indentCaseThen` //todo add sample30
`Integer`	`indentLen` //todo add sample20
`Boolean`	`insertBlankLineInBatchSqls` //todo add sample54
`TAlignStyle`	`insertColumnlistStyle` the align style for the insert column //todo add sample12
`TAlignStyle`	`insertValuelistStyle` the value style in insert statement //todo add sample13
`Boolean`	`linebreakAfterDeclare` declare statement //todo add sample44
`Boolean`	`linebreakBeforeParamInExec` used for execute statement //todo add sample52
`Boolean`	`linenumberEnabled` //todo add sample56
`Integer`	`linenumberLeftMargin` //todo add sample58
`Integer`	`linenumberRightMargin` //todo add sample59
`Boolean`	`linenumberZeroBased` //todo add sample57
`Integer`	`lineWidth` //todo add sample64
`Integer`	`maxSelectListColumn` //todo add issue 51
`Boolean`	`noEmptyLinesBetweenMultiSetStmts` //todo add sample55
`boolean`	`opearateSourceToken` if it is true, the helper class will operate the source tokens.
`GOutputFmt`	`outputFmt` used for sql output format.
`TLinefeedsCommaOption`	`parametersComma` //todo add sample46
`TAlignStyle`	`parametersStyle` //todo add sample45
`Boolean`	`removeComment` //todo add sample62
`TLinefeedsCommaOption`	`selectColumnlistComma` the comma style in select statement //todo add sample2
`TAlignStyle`	`selectColumnlistStyle` the align style for the select column //todo add sample1
`TLinefeedsCommaOption`	`selectFromclauseComma` the comma style in the from clause //todo add sample7
`boolean`	`selectFromclauseJoinOnInNewline` the join clause should start with a new line.
`TAlignStyle`	`selectFromclauseStyle` the table name style in the from clause //todo add sample6
`boolean`	`selectItemInNewLine` each column in the select statement should append a new line.
`TAlignOption`	`selectKeywordsAlignOption` //todo add sample31
`String`	`sessionId` the session id.
`String`	`tabHtmlString`
`Integer`	`tabSize` //todo add sample22
`boolean`	`treatDistinctAsVirtualColumn` //todo add sample5
`Boolean`	`useTab` //todo add sample21
`Boolean`	`wsPaddingOperatorArithmetic` //todo add sample37
`Boolean`	`wsPaddingParenthesesInExpression` //todo add sample39
`Boolean`	`wsPaddingParenthesesInFunction` //todo add sample38
`Boolean`	`wsPaddingParenthesesInFunctionCall` //todo add sample41
`Boolean`	`wsPaddingParenthesesOfSubQuery` //todo add sample40
`Boolean`	`wsPaddingParenthesesOfTypename` //todo add sample42

Constructor Summary

Constructors
Constructor and Description

GFmtOpt(String sessionId)

Constructors
Constructor and Description
`GFmtOpt(String sessionId)`

Method Summary
- Methods inherited from class Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - sessionId
```
public final String sessionId
```
    the session id. each thread can own only one id.
  - opearateSourceToken
```
public boolean opearateSourceToken
```
    if it is true, the helper class will operate the source tokens. if not, the helper class will ignore the operation request
  - selectColumnlistStyle
```
public TAlignStyle selectColumnlistStyle
```
    the align style for the select column //todo add sample1
  - selectColumnlistComma
```
public TLinefeedsCommaOption selectColumnlistComma
```
    the comma style in select statement //todo add sample2
  - selectItemInNewLine
```
public boolean selectItemInNewLine
```
    each column in the select statement should append a new line. //todo add sample3
  - alignAliasInSelectList
```
public boolean alignAliasInSelectList
```
    //todo add sample4
  - treatDistinctAsVirtualColumn
```
public boolean treatDistinctAsVirtualColumn
```
    //todo add sample5
  - selectFromclauseStyle
```
public TAlignStyle selectFromclauseStyle
```
    the table name style in the from clause //todo add sample6
  - selectFromclauseComma
```
public TLinefeedsCommaOption selectFromclauseComma
```
    the comma style in the from clause //todo add sample7
  - fromClauseInNewLine
```
public boolean fromClauseInNewLine
```
    each column in the table names in the form clause should start with a new line. //todo add sample8
  - selectFromclauseJoinOnInNewline
```
public boolean selectFromclauseJoinOnInNewline
```
    the join clause should start with a new line. //todo add sample9
  - alignJoinWithFromKeyword
```
public boolean alignJoinWithFromKeyword
```
    align 'join' keyword with 'from' keyword //todo add sample10
  - andOrUnderWhere
```
public boolean andOrUnderWhere
```
    in the where clause, the 'and' and 'or' keyword should under the 'where' keyword //todo add sample11
  - insertColumnlistStyle
```
public TAlignStyle insertColumnlistStyle
```
    the align style for the insert column //todo add sample12
  - insertValuelistStyle
```
public TAlignStyle insertValuelistStyle
```
    the value style in insert statement //todo add sample13
  - beStyleCreatetableLeftBEOnNewline
```
public boolean beStyleCreatetableLeftBEOnNewline
```
    //todo add sample14
  - beStyleCreatetableRightBEOnNewline
```
public boolean beStyleCreatetableRightBEOnNewline
```
    //todo add sample15
  - createtableListitemInNewLine
```
public boolean createtableListitemInNewLine
```
    //todo add sample16
  - createtableFieldlistAlignOption
```
public TAlignOption createtableFieldlistAlignOption
```
    //todo add sample17
  - defaultCommaOption
```
public TLinefeedsCommaOption defaultCommaOption
```
    //todo add sample18
  - defaultAligntype
```
public TAlignStyle defaultAligntype
```
    //todo add sample19
  - indentLen
```
public Integer indentLen
```
    //todo add sample20
  - useTab
```
public Boolean useTab
```
    //todo add sample21
  - tabSize
```
public Integer tabSize
```
    //todo add sample22
  - beStyleFunctionBodyIndent
```
public Integer beStyleFunctionBodyIndent
```
  - beStyleBlockLeftBEOnNewline
```
public Boolean beStyleBlockLeftBEOnNewline
```
    //todo add sample23
  - beStyleBlockLeftBEIndentSize
```
public Integer beStyleBlockLeftBEIndentSize
```
    //todo add sample24
  - beStyleBlockRightBEIndentSize
```
public Integer beStyleBlockRightBEIndentSize
```
    //todo add sample25
  - beStyleBlockIndentSize
```
public Integer beStyleBlockIndentSize
```
    //todo add sample26
  - beStyleIfElseSingleStmtIndentSize
```
public Integer beStyleIfElseSingleStmtIndentSize
```
    //todo add sample27
  - caseWhenThenInSameLine
```
public Boolean caseWhenThenInSameLine
```
    //todo add sample28
  - indentCaseFromSwitch
```
public Integer indentCaseFromSwitch
```
    //todo add sample29
  - indentCaseThen
```
public Integer indentCaseThen
```
    //todo add sample30
  - selectKeywordsAlignOption
```
public TAlignOption selectKeywordsAlignOption
```
    //todo add sample31
  - caseKeywords
```
public TCaseOption caseKeywords
```
    //todo add sample32
  - caseIdentifier
```
public TCaseOption caseIdentifier
```
    //todo add sample33
  - caseQuotedIdentifier
```
public TCaseOption caseQuotedIdentifier
```
    //todo add sample34
  - caseFuncname
```
public TCaseOption caseFuncname
```
    //todo add sample35
  - caseDatatype
```
public TCaseOption caseDatatype
```
    //todo add sample36
  - wsPaddingOperatorArithmetic
```
public Boolean wsPaddingOperatorArithmetic
```
    //todo add sample37
  - wsPaddingParenthesesInFunction
```
public Boolean wsPaddingParenthesesInFunction
```
    //todo add sample38
  - wsPaddingParenthesesInExpression
```
public Boolean wsPaddingParenthesesInExpression
```
    //todo add sample39
  - wsPaddingParenthesesOfSubQuery
```
public Boolean wsPaddingParenthesesOfSubQuery
```
    //todo add sample40
  - wsPaddingParenthesesInFunctionCall
```
public Boolean wsPaddingParenthesesInFunctionCall
```
    //todo add sample41
  - wsPaddingParenthesesOfTypename
```
public Boolean wsPaddingParenthesesOfTypename
```
    //todo add sample42
  - cteNewlineBeforeAs
```
public Boolean cteNewlineBeforeAs
```
    //todo add sample43
  - linebreakAfterDeclare
```
public Boolean linebreakAfterDeclare
```
    declare statement //todo add sample44
  - parametersStyle
```
public TAlignStyle parametersStyle
```
    //todo add sample45
  - parametersComma
```
public TLinefeedsCommaOption parametersComma
```
    //todo add sample46
  - beStyleFunctionLeftBEOnNewline
```
public Boolean beStyleFunctionLeftBEOnNewline
```
    //todo add sample47
  - beStyleFunctionLeftBEIndentSize
```
public Integer beStyleFunctionLeftBEIndentSize
```
    //todo add sample48
  - beStyleFunctionRightBEOnNewline
```
public Boolean beStyleFunctionRightBEOnNewline
```
    //todo add sample49
  - beStyleFunctionRightBEIndentSize
```
public Integer beStyleFunctionRightBEIndentSize
```
    //todo add sample50
  - beStyleFunctionFirstParamInNewline
```
public Boolean beStyleFunctionFirstParamInNewline
```
    //todo add sample51
  - linebreakBeforeParamInExec
```
public Boolean linebreakBeforeParamInExec
```
    used for execute statement //todo add sample52
  - emptyLines
```
public TEmptyLinesOption emptyLines
```
    //todo add sample53
  - insertBlankLineInBatchSqls
```
public Boolean insertBlankLineInBatchSqls
```
    //todo add sample54
  - noEmptyLinesBetweenMultiSetStmts
```
public Boolean noEmptyLinesBetweenMultiSetStmts
```
    //todo add sample55
  - linenumberEnabled
```
public Boolean linenumberEnabled
```
    //todo add sample56
  - linenumberZeroBased
```
public Boolean linenumberZeroBased
```
    //todo add sample57
  - linenumberLeftMargin
```
public Integer linenumberLeftMargin
```
    //todo add sample58
  - linenumberRightMargin
```
public Integer linenumberRightMargin
```
    //todo add sample59
  - functionCallParametersStyle
```
public TAlignStyle functionCallParametersStyle
```
    //todo add sample60
  - functionCallParametersComma
```
public TLinefeedsCommaOption functionCallParametersComma
```
    //todo add sample61
  - removeComment
```
public Boolean removeComment
```
    //todo add sample62
  - compactMode
```
public TCompactMode compactMode
```
    //todo add sample63
  - lineWidth
```
public Integer lineWidth
```
    //todo add sample64
  - maxSelectListColumn
```
public Integer maxSelectListColumn
```
    //todo add issue 51
  - outputFmt
```
public GOutputFmt outputFmt
```
    used for sql output format. //todo add sample65
    
    See Also:
    
    GOutputFmt
  - tabHtmlString
```
public String tabHtmlString
```
- Constructor Detail
  - GFmtOpt
```
public GFmtOpt(String sessionId)
```

Class GFmtOpt

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

sessionId

opearateSourceToken

selectColumnlistStyle

selectColumnlistComma

selectItemInNewLine

alignAliasInSelectList

treatDistinctAsVirtualColumn

selectFromclauseStyle

selectFromclauseComma

fromClauseInNewLine

selectFromclauseJoinOnInNewline

alignJoinWithFromKeyword

andOrUnderWhere

insertColumnlistStyle

insertValuelistStyle

beStyleCreatetableLeftBEOnNewline

beStyleCreatetableRightBEOnNewline

createtableListitemInNewLine

createtableFieldlistAlignOption

defaultCommaOption

defaultAligntype

indentLen

useTab

tabSize

beStyleFunctionBodyIndent

beStyleBlockLeftBEOnNewline

beStyleBlockLeftBEIndentSize

beStyleBlockRightBEIndentSize

beStyleBlockIndentSize

beStyleIfElseSingleStmtIndentSize

caseWhenThenInSameLine

indentCaseFromSwitch

indentCaseThen

selectKeywordsAlignOption

caseKeywords

caseIdentifier

caseQuotedIdentifier

caseFuncname

caseDatatype

wsPaddingOperatorArithmetic

wsPaddingParenthesesInFunction

wsPaddingParenthesesInExpression

wsPaddingParenthesesOfSubQuery

wsPaddingParenthesesInFunctionCall

wsPaddingParenthesesOfTypename

cteNewlineBeforeAs

linebreakAfterDeclare

parametersStyle

parametersComma

beStyleFunctionLeftBEOnNewline

beStyleFunctionLeftBEIndentSize

beStyleFunctionRightBEOnNewline

beStyleFunctionRightBEIndentSize

beStyleFunctionFirstParamInNewline

linebreakBeforeParamInExec

emptyLines

insertBlankLineInBatchSqls

noEmptyLinesBetweenMultiSetStmts

linenumberEnabled

linenumberZeroBased

linenumberLeftMargin

linenumberRightMargin

functionCallParametersStyle

functionCallParametersComma

removeComment

compactMode

lineWidth

maxSelectListColumn

outputFmt

tabHtmlString

Constructor Detail

GFmtOpt