gudusoft.gsqlparser.pp2.token

Class TransformPolicy

Object

gudusoft.gsqlparser.pp2.token.TransformPolicy

public final class TransformPolicy
extends Object

Changes to tokens or comments that the user explicitly asked a formatter to make, which the content check must therefore not count as "the output changed the SQL".

Each transformation is accepted only in its exact expected form: given the input token and the requested setting, the output token must be either unchanged or exactly the expected text. Everything a transformation does not cover is compared as before. Nothing is compared "case-insensitively" or "ignored" as a blanket rule, so a formatter that makes a different change than the one requested is still caught.

• variableCase: variables (@Total, :host) may have the requested case applied to the part after their prefix.
• quotedIdentifierCase: delimited names ("Name", [Name]) may have the requested case applied inside the delimiters.
• compactComments: compact mode may rewrite a line comment -- x as /* -- x */ (with or without the space before the closing delimiter), so it cannot swallow the rest of a compacted line.
• removeComments: comments may be removed, except optimizer hints (/*+ ... */), which must stay byte-exact and in order.

Used by TokenEquivalence for pp2's guards (through Pp2FormatOptions.transformPolicy) and by the format worker's checks, so every layer applies the same contract.

Field Summary

Fields

Modifier and Type	Field and Description
static TransformPolicy	NONE No transformation allowed: the plain content check.

Constructor Summary

Constructors

Constructor and Description
TransformPolicy(TCaseOption variableCase, TCaseOption quotedIdentifierCase, boolean compactComments, boolean removeComments)

Method Summary

Modifier and Type	Method and Description
TCaseOption	getQuotedIdentifierCase()
TCaseOption	getVariableCase()
boolean	isCompactComments()
boolean	isNone()
boolean	isRemoveComments()
String	toString()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NONE

public static final TransformPolicy NONE

No transformation allowed: the plain content check.

Constructor Detail

TransformPolicy

public TransformPolicy(TCaseOption variableCase,
                       TCaseOption quotedIdentifierCase,
                       boolean compactComments,
                       boolean removeComments)

Parameters:

variableCase - requested variable case, or null

quotedIdentifierCase - requested delimited-name case, or null

compactComments - compact mode's line-comment rewrite allowed

removeComments - comment removal (hints kept) allowed

Method Detail

getVariableCase

public TCaseOption getVariableCase()

getQuotedIdentifierCase

public TCaseOption getQuotedIdentifierCase()

isCompactComments

public boolean isCompactComments()

isRemoveComments

public boolean isRemoveComments()

isNone

public boolean isNone()

toString

public String toString()

Overrides:

toString in class Object