APIdia Launch Partner
Top Description Fields Constructors Methods
com.sun.tools.javac.tree

public Class Pretty

extends Visitor
Class Inheritance
Imports
java.io.*, java.util.Optional, com.sun.source.tree.MemberReferenceTree.ReferenceMode, .ModuleTree.ModuleKind, com.sun.tools.javac.code.*, com.sun.tools.javac.tree.JCTree.*, com.sun.tools.javac.util.*
Prints out a tree as an indented Java source program.

This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

Field Summary

Modifier and TypeField and Description
pack-priv DocCommentTable
docComments

A table mapping trees to their documentation comments (can be null)

pack-priv long
enclClassFlags

The enclosing class flags.

pack-priv Name
enclClassName

The enclosing class name.

pack-priv String
lineSep

pack-priv int
lmargin

The current left margin.

pack-priv Writer
out

The output stream on which trees are printed.

pack-priv int
prec

Visitor argument: the current precedence level.

private static final int
PREFERRED_LENGTH

Max number of chars to be generated when output should fit into a single line

private final boolean
sourceOutput

Set when we are producing source output.

private static final String
trimSequence

A string sequence to be used when Pretty output should be constrained to fit into a given size

public int
width

Indentation width (can be reassigned from outside).

Constructor Summary

AccessConstructor and Description
public
Pretty(Writer out, boolean sourceOutput)

Method Summary

Modifier and TypeMethod and Description
pack-priv void
align()

Align code to be indented to left margin.

pack-priv void
close(int
The precedence level we revert to.
contextPrec, int
The inner precedence level.
ownPrec)

Leave precedence level.

pack-priv void
indent()

Increase left margin by indentation width.

pack-priv boolean
isCompactRecordConstructor(JCTree t)

Is the given tree a compact record constructor?

pack-priv boolean
isEnumerator(JCTree t)

Is the given tree an enumerator definition?

pack-priv boolean
isGeneratedDefaultConstructor(JCTree t)

Is the given tree a generated default constructor?

pack-priv boolean
isRecordComponent(JCTree t)

Is the given tree a record component?

pack-priv boolean
isUsed(final Symbol t, JCTree cdef)

pack-priv static int
lineEndPos(String s, int start)

pack-priv void
open(int
The precedence level in force so far.
contextPrec, int
The new precedence level.
ownPrec)

Enter a new precedence level.

public String
operatorName(JCTree.Tag tag)

public void
printAnnotations(List<JCTree.JCAnnotation> trees)

private void
printBaseElementType(JCTree tree)

public void
printBlock(List<? extends JCTree> stats)

Print a block.

private void
printBrackets(JCTree tree)

public void
printDocComment(JCTree
The tree for which a documentation comment should be printed.
tree)

Print documentation comment, if it exists

public void
printEnumBody(List<JCTree> stats)

Print a block.

public void
printExpr(JCTree tree, int
The current precedence level.
prec)

Visitor method: print expression tree.

public void
printExpr(JCTree tree)

Derived visitor method: print expression tree at minimum precedence level for expression.

public <T extends JCTree> void
printExprs(List<T> trees, String
the separator string
sep)

Derived visitor method: print list of expression trees, separated by given string.

public <T extends JCTree> void
printExprs(List<T> trees)

Derived visitor method: print list of expression trees, separated by commas.

public void
printFlags(long flags)

Print a set of modifiers.

public void
println()

Print new line.

public void
printPattern(JCTree tree)

Derived visitor method: print pattern.

public void
printRecordBody(List<JCTree> stats)

Print a block.

public void
printRecordComponents(List<JCTree> stats)

Print record components.

public void
printStat(JCTree tree)

Derived visitor method: print statement tree.

public void
printStats(List<? extends JCTree> trees)

Derived visitor method: print list of statements, each on a separate line.

public void
printTypeAnnotations(List<JCTree.JCAnnotation> trees)

public void
printTypeParameters(List<JCTree.JCTypeParameter> trees)

If type parameter list is non-empty, print it enclosed in "<...

public void
printUnit(JCTree.JCCompilationUnit
The toplevel tree
tree, JCTree.JCClassDecl
The class definition, which is assumed to be part of the toplevel tree.
cdef)

Print unit consisting of package clause and import statements in toplevel, followed by class definition.

public static String
toSimpleString(JCTree tree)

public static String
toSimpleString(JCTree tree, int maxLength)

pack-priv void
undent()

Decrease left margin by indentation width.

public void
visitAnnotatedType(JCTree.JCAnnotatedType tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitAnnotatedType.

public void
visitAnnotation(JCTree.JCAnnotation tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitAnnotation.

public void
visitAnyPattern(JCTree.JCAnyPattern patt)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitAnyPattern.

public void
visitApply(JCTree.JCMethodInvocation tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitApply.

public void
visitAssert(JCTree.JCAssert tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitAssert.

public void
visitAssign(JCTree.JCAssign tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitAssign.

public void
visitAssignop(JCTree.JCAssignOp tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitAssignop.

public void
visitBinary(JCTree.JCBinary tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitBinary.

public void
visitBindingPattern(JCTree.JCBindingPattern patt)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitBindingPattern.

public void
visitBlock(JCTree.JCBlock tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitBlock.

public void
visitBreak(JCTree.JCBreak tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitBreak.

public void
visitCase(JCTree.JCCase tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitCase.

public void
visitCatch(JCTree.JCCatch tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitCatch.

public void
visitClassDef(JCTree.JCClassDecl tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitClassDef.

public void
visitConditional(JCTree.JCConditional tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitConditional.

public void
visitConstantCaseLabel(JCTree.JCConstantCaseLabel tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitConstantCaseLabel.

public void
visitContinue(JCTree.JCContinue tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitContinue.

public void
visitDefaultCaseLabel(JCTree.JCDefaultCaseLabel that)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitDefaultCaseLabel.

public void
visitDoLoop(JCTree.JCDoWhileLoop tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitDoLoop.

public void
visitErroneous(JCTree.JCErroneous tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitErroneous.

public void
visitExec(JCTree.JCExpressionStatement tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitExec.

public void
visitExports(JCTree.JCExports tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitExports.

public void
visitForeachLoop(JCTree.JCEnhancedForLoop tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitForeachLoop.

public void
visitForLoop(JCTree.JCForLoop tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitForLoop.

public void
visitIdent(JCTree.JCIdent tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitIdent.

public void
visitIf(JCTree.JCIf tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitIf.

public void
visitImport(JCTree.JCImport tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitImport.

public void
visitIndexed(JCTree.JCArrayAccess tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitIndexed.

public void
visitLabelled(JCTree.JCLabeledStatement tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitLabelled.

public void
visitLambda(JCTree.JCLambda tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitLambda.

public void
visitLetExpr(JCTree.LetExpr tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitLetExpr.

public void
visitLiteral(JCTree.JCLiteral tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitLiteral.

public void
visitMethodDef(JCTree.JCMethodDecl tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitMethodDef.

public void
visitModifiers(JCTree.JCModifiers mods)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitModifiers.

public void
visitModuleDef(JCTree.JCModuleDecl tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitModuleDef.

public void
visitModuleImport(JCTree.JCModuleImport tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitModuleImport.

public void
visitNewArray(JCTree.JCNewArray tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitNewArray.

public void
visitNewClass(JCTree.JCNewClass tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitNewClass.

public void
visitOpens(JCTree.JCOpens tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitOpens.

public void
visitPackageDef(JCTree.JCPackageDecl tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitPackageDef.

public void
visitParens(JCTree.JCParens tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitParens.

public void
visitPatternCaseLabel(JCTree.JCPatternCaseLabel tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitPatternCaseLabel.

public void
visitProvides(JCTree.JCProvides tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitProvides.

public void
visitRecordPattern(JCTree.JCRecordPattern tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitRecordPattern.

public void
visitReference(JCTree.JCMemberReference tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitReference.

public void
visitRequires(JCTree.JCRequires tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitRequires.

public void
visitReturn(JCTree.JCReturn tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitReturn.

public void
visitSelect(JCTree.JCFieldAccess tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitSelect.

public void
visitSkip(JCTree.JCSkip tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitSkip.

public void
visitSwitch(JCTree.JCSwitch tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitSwitch.

public void
visitSwitchExpression(JCTree.JCSwitchExpression tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitSwitchExpression.

public void
visitSynchronized(JCTree.JCSynchronized tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitSynchronized.

public void
visitThrow(JCTree.JCThrow tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitThrow.

public void
visitTopLevel(JCTree.JCCompilationUnit tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitTopLevel.

public void
visitTree(JCTree tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitTree.

public void
visitTry(JCTree.JCTry tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitTry.

public void
visitTypeApply(JCTree.JCTypeApply tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitTypeApply.

public void
visitTypeArray(JCTree.JCArrayTypeTree tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitTypeArray.

public void
visitTypeBoundKind(JCTree.TypeBoundKind tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitTypeBoundKind.

public void
visitTypeCast(JCTree.JCTypeCast tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitTypeCast.

public void
visitTypeIdent(JCTree.JCPrimitiveTypeTree tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitTypeIdent.

public void
visitTypeIntersection(JCTree.JCTypeIntersection tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitTypeIntersection.

public void
visitTypeParameter(JCTree.JCTypeParameter tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitTypeParameter.

public void
visitTypeTest(JCTree.JCInstanceOf tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitTypeTest.

public void
visitTypeUnion(JCTree.JCTypeUnion tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitTypeUnion.

public void
visitUnary(JCTree.JCUnary tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitUnary.

public void
visitUses(JCTree.JCUses tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitUses.

public void
visitVarDef(JCTree.JCVariableDecl tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitVarDef.

public void
visitVarType(JCTree.JCVarType that)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitVarType.

public void
visitWhileLoop(JCTree.JCWhileLoop tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitWhileLoop.

public void
visitWildcard(JCTree.JCWildcard tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitWildcard.

public void
visitYield(JCTree.JCYield tree)

Overrides com.sun.tools.javac.tree.JCTree.Visitor.visitYield.