Module com.google.googlejavaformat
Package com.google.googlejavaformat.java
Class JavaInputAstVisitor
java.lang.Object
com.sun.source.util.TreeScanner<R,P>
com.sun.source.util.TreePathScanner<Void,Void>
com.google.googlejavaformat.java.JavaInputAstVisitor
- All Implemented Interfaces:
TreeVisitor<Void,Void>
- Direct Known Subclasses:
Java14InputAstVisitor
public class JavaInputAstVisitor extends TreePathScanner<Void,Void>
An AST visitor that builds a stream of
Ops to format from the given CompilationUnitTree.-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static classJavaInputAstVisitor.BracesOrNotWhether to include braces.protected static classJavaInputAstVisitor.DirectionDirection for Annotations (usually VERTICAL).protected static classJavaInputAstVisitor.FirstDeclarationsOrNotWhether these declarations are the first in the block. -
Field Summary
Fields Modifier and Type Field Description protected OpsBuilderbuilderprotected static longCOMPACT_RECORD_CONSTRUCTORprotected intindentMultiplierprotected Indent.ConstminusFourprotected Indent.ConstminusTwoprotected Indent.ConstplusFourprotected Indent.ConstplusTwoprotected static longRECORDprotected static Indent.ConstZERO -
Constructor Summary
Constructors Constructor Description JavaInputAstVisitor(OpsBuilder builder, int indentMultiplier)TheVisitorconstructor. -
Method Summary
Methods inherited from class com.sun.source.util.TreeScanner
reduce, scan, visitBindingPattern, visitErroneous, visitOther, visitPackage, visitSwitchExpression, visitYield
-
Field Details
-
builder
-
ZERO
-
indentMultiplier
protected final int indentMultiplier -
minusTwo
-
minusFour
-
plusTwo
-
plusFour
-
COMPACT_RECORD_CONSTRUCTOR
protected static final long COMPACT_RECORD_CONSTRUCTOR- See Also:
- Constant Field Values
-
RECORD
protected static final long RECORD- See Also:
- Constant Field Values
-
-
Constructor Details
-
JavaInputAstVisitor
TheVisitorconstructor.- Parameters:
builder- theOpsBuilder
-
-
Method Details
-
scan
- Overrides:
scanin classTreePathScanner<Void,Void>
-
visitCompilationUnit
- Specified by:
visitCompilationUnitin interfaceTreeVisitor<Void,Void>- Overrides:
visitCompilationUnitin classTreeScanner<Void,Void>
-
dropEmptyDeclarations
protected void dropEmptyDeclarations()Skips over extra semi-colons at the top-level, or in a class member declaration lists. -
visitClass
- Specified by:
visitClassin interfaceTreeVisitor<Void,Void>- Overrides:
visitClassin classTreeScanner<Void,Void>
-
visitAnnotationType
-
visitArrayAccess
- Specified by:
visitArrayAccessin interfaceTreeVisitor<Void,Void>- Overrides:
visitArrayAccessin classTreeScanner<Void,Void>
-
visitNewArray
- Specified by:
visitNewArrayin interfaceTreeVisitor<Void,Void>- Overrides:
visitNewArrayin classTreeScanner<Void,Void>
-
visitArrayInitializer
-
visitArrayType
- Specified by:
visitArrayTypein interfaceTreeVisitor<Void,Void>- Overrides:
visitArrayTypein classTreeScanner<Void,Void>
-
visitAssert
- Specified by:
visitAssertin interfaceTreeVisitor<Void,Void>- Overrides:
visitAssertin classTreeScanner<Void,Void>
-
visitAssignment
- Specified by:
visitAssignmentin interfaceTreeVisitor<Void,Void>- Overrides:
visitAssignmentin classTreeScanner<Void,Void>
-
visitBlock
- Specified by:
visitBlockin interfaceTreeVisitor<Void,Void>- Overrides:
visitBlockin classTreeScanner<Void,Void>
-
visitCompoundAssignment
- Specified by:
visitCompoundAssignmentin interfaceTreeVisitor<Void,Void>- Overrides:
visitCompoundAssignmentin classTreeScanner<Void,Void>
-
visitBreak
- Specified by:
visitBreakin interfaceTreeVisitor<Void,Void>- Overrides:
visitBreakin classTreeScanner<Void,Void>
-
visitTypeCast
- Specified by:
visitTypeCastin interfaceTreeVisitor<Void,Void>- Overrides:
visitTypeCastin classTreeScanner<Void,Void>
-
visitNewClass
- Specified by:
visitNewClassin interfaceTreeVisitor<Void,Void>- Overrides:
visitNewClassin classTreeScanner<Void,Void>
-
visitConditionalExpression
- Specified by:
visitConditionalExpressionin interfaceTreeVisitor<Void,Void>- Overrides:
visitConditionalExpressionin classTreeScanner<Void,Void>
-
visitContinue
- Specified by:
visitContinuein interfaceTreeVisitor<Void,Void>- Overrides:
visitContinuein classTreeScanner<Void,Void>
-
visitDoWhileLoop
- Specified by:
visitDoWhileLoopin interfaceTreeVisitor<Void,Void>- Overrides:
visitDoWhileLoopin classTreeScanner<Void,Void>
-
visitEmptyStatement
- Specified by:
visitEmptyStatementin interfaceTreeVisitor<Void,Void>- Overrides:
visitEmptyStatementin classTreeScanner<Void,Void>
-
visitEnhancedForLoop
- Specified by:
visitEnhancedForLoopin interfaceTreeVisitor<Void,Void>- Overrides:
visitEnhancedForLoopin classTreeScanner<Void,Void>
-
visitEnumDeclaration
-
visitMemberReference
- Specified by:
visitMemberReferencein interfaceTreeVisitor<Void,Void>- Overrides:
visitMemberReferencein classTreeScanner<Void,Void>
-
visitExpressionStatement
- Specified by:
visitExpressionStatementin interfaceTreeVisitor<Void,Void>- Overrides:
visitExpressionStatementin classTreeScanner<Void,Void>
-
visitVariable
- Specified by:
visitVariablein interfaceTreeVisitor<Void,Void>- Overrides:
visitVariablein classTreeScanner<Void,Void>
-
visitForLoop
- Specified by:
visitForLoopin interfaceTreeVisitor<Void,Void>- Overrides:
visitForLoopin classTreeScanner<Void,Void>
-
visitIf
- Specified by:
visitIfin interfaceTreeVisitor<Void,Void>- Overrides:
visitIfin classTreeScanner<Void,Void>
-
visitImport
- Specified by:
visitImportin interfaceTreeVisitor<Void,Void>- Overrides:
visitImportin classTreeScanner<Void,Void>
-
visitBinary
- Specified by:
visitBinaryin interfaceTreeVisitor<Void,Void>- Overrides:
visitBinaryin classTreeScanner<Void,Void>
-
visitInstanceOf
- Specified by:
visitInstanceOfin interfaceTreeVisitor<Void,Void>- Overrides:
visitInstanceOfin classTreeScanner<Void,Void>
-
visitIntersectionType
- Specified by:
visitIntersectionTypein interfaceTreeVisitor<Void,Void>- Overrides:
visitIntersectionTypein classTreeScanner<Void,Void>
-
visitLabeledStatement
- Specified by:
visitLabeledStatementin interfaceTreeVisitor<Void,Void>- Overrides:
visitLabeledStatementin classTreeScanner<Void,Void>
-
visitLambdaExpression
- Specified by:
visitLambdaExpressionin interfaceTreeVisitor<Void,Void>- Overrides:
visitLambdaExpressionin classTreeScanner<Void,Void>
-
visitAnnotation
- Specified by:
visitAnnotationin interfaceTreeVisitor<Void,Void>- Overrides:
visitAnnotationin classTreeScanner<Void,Void>
-
visitAnnotationArgument
-
visitAnnotatedType
- Specified by:
visitAnnotatedTypein interfaceTreeVisitor<Void,Void>- Overrides:
visitAnnotatedTypein classTreeScanner<Void,Void>
-
visitMethod
- Specified by:
visitMethodin interfaceTreeVisitor<Void,Void>- Overrides:
visitMethodin classTreeScanner<Void,Void>
-
visitMethodInvocation
- Specified by:
visitMethodInvocationin interfaceTreeVisitor<Void,Void>- Overrides:
visitMethodInvocationin classTreeScanner<Void,Void>
-
visitMemberSelect
- Specified by:
visitMemberSelectin interfaceTreeVisitor<Void,Void>- Overrides:
visitMemberSelectin classTreeScanner<Void,Void>
-
visitLiteral
- Specified by:
visitLiteralin interfaceTreeVisitor<Void,Void>- Overrides:
visitLiteralin classTreeScanner<Void,Void>
-
visitParameterizedType
- Specified by:
visitParameterizedTypein interfaceTreeVisitor<Void,Void>- Overrides:
visitParameterizedTypein classTreeScanner<Void,Void>
-
visitParenthesized
- Specified by:
visitParenthesizedin interfaceTreeVisitor<Void,Void>- Overrides:
visitParenthesizedin classTreeScanner<Void,Void>
-
visitUnary
- Specified by:
visitUnaryin interfaceTreeVisitor<Void,Void>- Overrides:
visitUnaryin classTreeScanner<Void,Void>
-
visitPrimitiveType
- Specified by:
visitPrimitiveTypein interfaceTreeVisitor<Void,Void>- Overrides:
visitPrimitiveTypein classTreeScanner<Void,Void>
-
visit
-
visitReturn
- Specified by:
visitReturnin interfaceTreeVisitor<Void,Void>- Overrides:
visitReturnin classTreeScanner<Void,Void>
-
visitCase
- Specified by:
visitCasein interfaceTreeVisitor<Void,Void>- Overrides:
visitCasein classTreeScanner<Void,Void>
-
visitSwitch
- Specified by:
visitSwitchin interfaceTreeVisitor<Void,Void>- Overrides:
visitSwitchin classTreeScanner<Void,Void>
-
visitSwitch
-
visitSynchronized
- Specified by:
visitSynchronizedin interfaceTreeVisitor<Void,Void>- Overrides:
visitSynchronizedin classTreeScanner<Void,Void>
-
visitThrow
- Specified by:
visitThrowin interfaceTreeVisitor<Void,Void>- Overrides:
visitThrowin classTreeScanner<Void,Void>
-
visitTry
- Specified by:
visitTryin interfaceTreeVisitor<Void,Void>- Overrides:
visitTryin classTreeScanner<Void,Void>
-
visitClassDeclaration
-
visitTypeParameter
- Specified by:
visitTypeParameterin interfaceTreeVisitor<Void,Void>- Overrides:
visitTypeParameterin classTreeScanner<Void,Void>
-
visitUnionType
- Specified by:
visitUnionTypein interfaceTreeVisitor<Void,Void>- Overrides:
visitUnionTypein classTreeScanner<Void,Void>
-
visitWhileLoop
- Specified by:
visitWhileLoopin interfaceTreeVisitor<Void,Void>- Overrides:
visitWhileLoopin classTreeScanner<Void,Void>
-
visitWildcard
- Specified by:
visitWildcardin interfaceTreeVisitor<Void,Void>- Overrides:
visitWildcardin classTreeScanner<Void,Void>
-
visitStatements
-
visitModifiers
- Specified by:
visitModifiersin interfaceTreeVisitor<Void,Void>- Overrides:
visitModifiersin classTreeScanner<Void,Void>
-
visitModifiers
protected List<Op> visitModifiers(ModifiersTree modifiersTree, JavaInputAstVisitor.Direction annotationsDirection, Optional<Output.BreakTag> declarationAnnotationBreak)Output combined modifiers and annotations and returns the trailing break. -
visitModifiers
protected List<Op> visitModifiers(List<? extends AnnotationTree> annotationTrees, JavaInputAstVisitor.Direction annotationsDirection, Optional<Output.BreakTag> declarationAnnotationBreak) -
visitCatch
- Specified by:
visitCatchin interfaceTreeVisitor<Void,Void>- Overrides:
visitCatchin classTreeScanner<Void,Void>
-
visitFormals
protected void visitFormals(Optional<VariableTree> receiver, List<? extends VariableTree> parameters) -
visitIdentifier
- Specified by:
visitIdentifierin interfaceTreeVisitor<Void,Void>- Overrides:
visitIdentifierin classTreeScanner<Void,Void>
-
visitModule
- Specified by:
visitModulein interfaceTreeVisitor<Void,Void>- Overrides:
visitModulein classTreeScanner<Void,Void>
-
visitExports
- Specified by:
visitExportsin interfaceTreeVisitor<Void,Void>- Overrides:
visitExportsin classTreeScanner<Void,Void>
-
visitOpens
- Specified by:
visitOpensin interfaceTreeVisitor<Void,Void>- Overrides:
visitOpensin classTreeScanner<Void,Void>
-
visitProvides
- Specified by:
visitProvidesin interfaceTreeVisitor<Void,Void>- Overrides:
visitProvidesin classTreeScanner<Void,Void>
-
visitRequires
- Specified by:
visitRequiresin interfaceTreeVisitor<Void,Void>- Overrides:
visitRequiresin classTreeScanner<Void,Void>
-
visitUses
- Specified by:
visitUsesin interfaceTreeVisitor<Void,Void>- Overrides:
visitUsesin classTreeScanner<Void,Void>
-
typeParametersRest
protected void typeParametersRest(List<? extends TypeParameterTree> typeParameters, Indent plusIndent)Does not omit the leading"<", which should be associated with the type name. -
addBodyDeclarations
protected void addBodyDeclarations(List<? extends Tree> bodyDeclarations, JavaInputAstVisitor.BracesOrNot braces, JavaInputAstVisitor.FirstDeclarationsOrNot first0)Add a list of declarations. -
token
Emit aDoc.Token. -
token
Emit aDoc.Token. -
markForPartialFormat
protected void markForPartialFormat() -
sync
Sync to position in the input. If we've skipped outputting any tokens that were present in the input tokens, output them here and complain.- Parameters:
node- the ASTNode holding the input position
-
toString
-