gudusoft.gsqlparser.pp2.layout

Class LayoutDecision

Object

gudusoft.gsqlparser.pp2.layout.LayoutDecision

All Implemented Interfaces:

LayoutDecisionView

public final class LayoutDecision
extends Object
implements LayoutDecisionView

The layout decision for the whitespace before one token: how many linebreaks and blanks should precede it, and at what indent level it sits.

Each property defaults to UNSET (-1), meaning "no rule decided this; the output writer should fall back to the token's original precedingLinebreaks / precedingBlanks". This is what makes the zero-rule pipeline an identity pass.

Properties are written only through LayoutContext's request methods, which apply the LayoutConflictResolver precedence. The fields are package-visible setters so the context (same package) can apply resolved writes; rules never set them directly.

Consumers read decisions through the LayoutDecisionView interface (what LayoutContext.decisionAt(int) returns); the mutating setters are package-visible so only LayoutContext (same package) applies resolved writes. The layout rules live in the sub-package pp2.layout.rules, so they cannot reach these setters and must use the context's request* methods — keeping all writes under LayoutConflictResolver precedence.

Plan reference: §7.3/S23, §7.4/S23.

Field Summary

Fields

Modifier and Type	Field and Description
static int	UNSET Sentinel: this property has not been decided by any rule.

Constructor Summary

Constructors

Constructor and Description
LayoutDecision()

Method Summary

Modifier and Type	Method and Description
int	getBlanksBefore() Number of blank columns to emit before the token, or UNSET.
int	getIndentLevel() Indent level for the token's line, or UNSET.
int	getLinebreaksBefore() Number of linebreaks to emit before the token, or UNSET.
String	getTextOverride() The text to emit for the token instead of its source text, or null.
boolean	isBlanksDecided()
boolean	isIndentDecided()
boolean	isLinebreaksDecided()
boolean	isTextDecided()
String	toString()

Methods inherited from class Object

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

Field Detail

UNSET

public static final int UNSET

Sentinel: this property has not been decided by any rule.

See Also:

Constant Field Values

Constructor Detail

LayoutDecision

public LayoutDecision()

Method Detail

getLinebreaksBefore

public int getLinebreaksBefore()

Number of linebreaks to emit before the token, or UNSET.

Specified by:

getLinebreaksBefore in interface LayoutDecisionView

getBlanksBefore

public int getBlanksBefore()

Number of blank columns to emit before the token, or UNSET.

Specified by:

getBlanksBefore in interface LayoutDecisionView

getIndentLevel

public int getIndentLevel()

Indent level for the token's line, or UNSET.

Specified by:

getIndentLevel in interface LayoutDecisionView

isLinebreaksDecided

public boolean isLinebreaksDecided()

Specified by:

isLinebreaksDecided in interface LayoutDecisionView

isBlanksDecided

public boolean isBlanksDecided()

Specified by:

isBlanksDecided in interface LayoutDecisionView

isIndentDecided

public boolean isIndentDecided()

Specified by:

isIndentDecided in interface LayoutDecisionView

getTextOverride

public String getTextOverride()

The text to emit for the token instead of its source text, or null.

Specified by:

getTextOverride in interface LayoutDecisionView

isTextDecided

public boolean isTextDecided()

Specified by:

isTextDecided in interface LayoutDecisionView

toString

public String toString()

Overrides:

toString in class Object