Package com.github.javaparser.printer

Class DefaultPrettyPrinterVisitor

java.lang.Object

com.github.javaparser.printer.DefaultPrettyPrinterVisitor

All Implemented Interfaces:

VoidVisitor<Void>

public class DefaultPrettyPrinterVisitor
extends Object
implements VoidVisitor<Void>

Outputs the AST as formatted Java source code.

Field Summary

Fields

Modifier and Type	Field	Description
protected PrinterConfiguration	configuration	The printer configuration.
protected SourcePrinter	printer	Object for outputting source code.

Constructor Summary

Constructors

Constructor	Description
DefaultPrettyPrinterVisitor(PrinterConfiguration configuration)
DefaultPrettyPrinterVisitor(PrinterConfiguration configuration, SourcePrinter printer)

Method Summary

Modifier and Type	Method	Description
protected Optional<ConfigurationOption>	getOption(DefaultPrinterConfiguration.ConfigOption cOption)	Get the value of a given configuration option.
protected void	printAnnotations(NodeList<AnnotationExpr> annotations, boolean prefixWithASpace, Void arg)	Prints a list of annotations.
protected <T extends Expression> void	printArguments(NodeList<T> args, Void arg)	Outputs arguments to a method/constructor call.
protected void	printComment(Optional<Comment> comment, Void arg)	Output a comment, if any.
protected void	printCompactClassMembers(NodeList<BodyDeclaration<?>> members, Void arg)	Print a list of compact class members.
protected void	printImports(NodeList<ImportDeclaration> imports, Void arg)	Print imports using an import ordering strategy.
protected void	printMemberAnnotations(NodeList<AnnotationExpr> annotations, Void arg)	Print a list of annotations on a member, i.e., a top-level or body declaration.
protected void	printMembers(NodeList<BodyDeclaration<?>> members, Void arg)	Print a list of body declarations.
protected void	printModifiers(NodeList<Modifier> modifiers)	Print a list of modifiers on a declaration.
protected void	printOrphanCommentsBeforeThisChildNode(Node node)	Print all orphaned comments coming right before node.
protected void	printOrphanCommentsEnding(Node node)	Print all orphan comments coming at the end of the given node.
protected void	printPrePostFixOptionalList(NodeList<? extends Visitable> args, Void arg, String prefix, String separator, String postfix)	General list output functionality - no output for empty lists.
protected void	printPrePostFixRequiredList(NodeList<? extends Visitable> args, Void arg, String prefix, String separator, String postfix)	General list output functionality with output for empty lists.
protected void	printTypeArgs(NodeWithTypeArguments<?> nodeWithTypeArguments, Void arg)	Print type arguments.
protected void	printTypeParameters(NodeList<TypeParameter> args, Void arg)	Print type parameters.
String	toString()
void	visit(ArrayCreationLevel n, Void arg)
void	visit(AnnotationDeclaration n, Void arg)
void	visit(AnnotationMemberDeclaration n, Void arg)
void	visit(ClassOrInterfaceDeclaration n, Void arg)
void	visit(CompactConstructorDeclaration n, Void arg)
void	visit(ConstructorDeclaration n, Void arg)
void	visit(EnumConstantDeclaration n, Void arg)
void	visit(EnumDeclaration n, Void arg)
void	visit(FieldDeclaration n, Void arg)
void	visit(InitializerDeclaration n, Void arg)
void	visit(MethodDeclaration n, Void arg)
void	visit(Parameter n, Void arg)
void	visit(ReceiverParameter n, Void arg)
void	visit(RecordDeclaration n, Void arg)
void	visit(VariableDeclarator n, Void arg)
void	visit(BlockComment n, Void arg)
void	visit(LineComment n, Void arg)
void	visit(MarkdownComment n, Void arg)
void	visit(TraditionalJavadocComment n, Void arg)
void	visit(CompilationUnit n, Void arg)
void	visit(ArrayAccessExpr n, Void arg)
void	visit(ArrayCreationExpr n, Void arg)
void	visit(ArrayInitializerExpr n, Void arg)
void	visit(AssignExpr n, Void arg)
void	visit(BinaryExpr n, Void arg)	work in progress for issue-545
void	visit(BooleanLiteralExpr n, Void arg)
void	visit(CastExpr n, Void arg)
void	visit(CharLiteralExpr n, Void arg)
void	visit(ClassExpr n, Void arg)
void	visit(ConditionalExpr n, Void arg)
void	visit(DoubleLiteralExpr n, Void arg)
void	visit(EnclosedExpr n, Void arg)
void	visit(FieldAccessExpr n, Void arg)
void	visit(InstanceOfExpr n, Void arg)
void	visit(IntegerLiteralExpr n, Void arg)
void	visit(LambdaExpr n, Void arg)
void	visit(LongLiteralExpr n, Void arg)
void	visit(MarkerAnnotationExpr n, Void arg)
void	visit(MatchAllPatternExpr n, Void arg)
void	visit(MemberValuePair n, Void arg)
void	visit(MethodCallExpr n, Void arg)
void	visit(MethodReferenceExpr n, Void arg)
void	visit(NameExpr n, Void arg)
void	visit(Name n, Void arg)
void	visit(NormalAnnotationExpr n, Void arg)
void	visit(NullLiteralExpr n, Void arg)
void	visit(ObjectCreationExpr n, Void arg)
void	visit(RecordPatternExpr n, Void arg)
void	visit(SimpleName n, Void arg)
void	visit(SingleMemberAnnotationExpr n, Void arg)
void	visit(StringLiteralExpr n, Void arg)
void	visit(SuperExpr n, Void arg)
void	visit(SwitchExpr n, Void arg)
void	visit(TextBlockLiteralExpr n, Void arg)
void	visit(ThisExpr n, Void arg)
void	visit(TypeExpr n, Void arg)
void	visit(TypePatternExpr n, Void arg)
void	visit(UnaryExpr n, Void arg)
void	visit(VariableDeclarationExpr n, Void arg)
void	visit(ImportDeclaration n, Void arg)
void	visit(Modifier n, Void arg)
void	visit(ModuleDeclaration n, Void arg)
void	visit(ModuleExportsDirective n, Void arg)
void	visit(ModuleOpensDirective n, Void arg)
void	visit(ModuleProvidesDirective n, Void arg)
void	visit(ModuleRequiresDirective n, Void arg)
void	visit(ModuleUsesDirective n, Void arg)
void	visit(NodeList n, Void arg)
void	visit(PackageDeclaration n, Void arg)
void	visit(AssertStmt n, Void arg)
void	visit(BlockStmt n, Void arg)
void	visit(BreakStmt n, Void arg)
void	visit(CatchClause n, Void arg)
void	visit(ContinueStmt n, Void arg)
void	visit(DoStmt n, Void arg)
void	visit(EmptyStmt n, Void arg)
void	visit(ExplicitConstructorInvocationStmt n, Void arg)
void	visit(ExpressionStmt n, Void arg)
void	visit(ForEachStmt n, Void arg)
void	visit(ForStmt n, Void arg)
void	visit(IfStmt n, Void arg)
void	visit(LabeledStmt n, Void arg)
void	visit(LocalClassDeclarationStmt n, Void arg)
void	visit(LocalRecordDeclarationStmt n, Void arg)
void	visit(ReturnStmt n, Void arg)
void	visit(SwitchEntry n, Void arg)
void	visit(SwitchStmt n, Void arg)
void	visit(SynchronizedStmt n, Void arg)
void	visit(ThrowStmt n, Void arg)
void	visit(TryStmt n, Void arg)
void	visit(UnparsableStmt n, Void arg)
void	visit(WhileStmt n, Void arg)
void	visit(YieldStmt n, Void arg)
void	visit(ArrayType n, Void arg)
void	visit(ClassOrInterfaceType n, Void arg)
void	visit(IntersectionType n, Void arg)
void	visit(PrimitiveType n, Void arg)
void	visit(TypeParameter n, Void arg)
void	visit(UnionType n, Void arg)
void	visit(UnknownType n, Void arg)
void	visit(VarType n, Void arg)
void	visit(VoidType n, Void arg)
void	visit(WildcardType n, Void arg)

Methods inherited from class java.lang.Object

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

Field Detail

configuration

protected final PrinterConfiguration configuration

The printer configuration.

printer

protected final SourcePrinter printer

Object for outputting source code.

Constructor Detail

DefaultPrettyPrinterVisitor

public DefaultPrettyPrinterVisitor(PrinterConfiguration configuration)

DefaultPrettyPrinterVisitor

public DefaultPrettyPrinterVisitor(PrinterConfiguration configuration,
                                   SourcePrinter printer)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

printModifiers

protected void printModifiers(NodeList<Modifier> modifiers)

Print a list of modifiers on a declaration. By default, this simply outputs the string representations of the modifiers separated by spaces.

printMembers

protected void printMembers(NodeList<BodyDeclaration<?>> members,
                            Void arg)

Print a list of body declarations. By default, this outputs declarations surrounded with a newline before and after.

printCompactClassMembers

protected void printCompactClassMembers(NodeList<BodyDeclaration<?>> members,
                                        Void arg)

Print a list of compact class members. This is similar to {@see printMembers} with the exception that the empty lines preceding the first member and following the last member are not printed.

printMemberAnnotations

protected void printMemberAnnotations(NodeList<AnnotationExpr> annotations,
                                      Void arg)

Print a list of annotations on a member, i.e., a top-level or body declaration. By default, this outputs each annotation on a separate line.

printAnnotations

protected void printAnnotations(NodeList<AnnotationExpr> annotations,
                                boolean prefixWithASpace,
                                Void arg)

Prints a list of annotations. By default, outputs the annotations followed by spaces. If prefixWithASpace is set, outputs an additional space at the beginning if there are annotations to output.

printTypeArgs

protected void printTypeArgs(NodeWithTypeArguments<?> nodeWithTypeArguments,
                             Void arg)

Print type arguments. This outputs type arguments using the <T1, ..., Tn> syntax.

printTypeParameters

protected void printTypeParameters(NodeList<TypeParameter> args,
                                   Void arg)

Print type parameters. This outputs type parameters using the <T1 [extends ...] [super...], ..., Tn> syntax.

printArguments

protected <T extends Expression> void printArguments(NodeList<T> args,
                                                     Void arg)

Outputs arguments to a method/constructor call. This outputs arguments using the (arg1, ..., argn) syntax, using either one-line or multi-line argument lists.

printPrePostFixOptionalList

protected void printPrePostFixOptionalList(NodeList<? extends Visitable> args,
                                           Void arg,
                                           String prefix,
                                           String separator,
                                           String postfix)

General list output functionality - no output for empty lists. This outputs nothing if args is empty, and prefix args[0] separator ... separator arg[n] suffix otherwise.

Parameters:

args - the nodes to output

arg - ignored

prefix - prefix for the list output

separator - seperator between the list items

postfix - suffix for the list output

printPrePostFixRequiredList

protected void printPrePostFixRequiredList(NodeList<? extends Visitable> args,
                                           Void arg,
                                           String prefix,
                                           String separator,
                                           String postfix)

General list output functionality with output for empty lists. This outputs @{code prefix suffix} if args is empty, and prefix args[0] separator ... separator arg[n] suffix otherwise.

Parameters:

args - the nodes to output

arg - ignored

prefix - prefix for the list output

separator - seperator between the list items

postfix - suffix for the list output

printComment

protected void printComment(Optional<Comment> comment,
                            Void arg)

Output a comment, if any.

visit

public void visit(CompilationUnit n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(PackageDeclaration n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(NameExpr n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(Name n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(SimpleName n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(ClassOrInterfaceDeclaration n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(RecordDeclaration n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(TraditionalJavadocComment n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(ClassOrInterfaceType n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(TypeParameter n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(PrimitiveType n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(ArrayType n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(ArrayCreationLevel n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(IntersectionType n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(UnionType n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(WildcardType n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(UnknownType n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(FieldDeclaration n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(VariableDeclarator n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(ArrayInitializerExpr n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(VoidType n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(VarType n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(Modifier n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(ArrayAccessExpr n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(ArrayCreationExpr n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(AssignExpr n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(BinaryExpr n,
                  Void arg)

work in progress for issue-545

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(CastExpr n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(ClassExpr n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(ConditionalExpr n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(EnclosedExpr n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(FieldAccessExpr n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(InstanceOfExpr n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(TypePatternExpr n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(RecordPatternExpr n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(MatchAllPatternExpr n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(CharLiteralExpr n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(DoubleLiteralExpr n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(IntegerLiteralExpr n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(LongLiteralExpr n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(StringLiteralExpr n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(TextBlockLiteralExpr n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(BooleanLiteralExpr n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(NullLiteralExpr n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(ThisExpr n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(SuperExpr n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(MethodCallExpr n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(ObjectCreationExpr n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(UnaryExpr n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(ConstructorDeclaration n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(CompactConstructorDeclaration n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(MethodDeclaration n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(Parameter n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(ReceiverParameter n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(ExplicitConstructorInvocationStmt n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(VariableDeclarationExpr n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(LocalClassDeclarationStmt n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(LocalRecordDeclarationStmt n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(AssertStmt n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(BlockStmt n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(LabeledStmt n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(EmptyStmt n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(ExpressionStmt n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(SwitchStmt n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(SwitchExpr n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(SwitchEntry n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(BreakStmt n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(YieldStmt n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(ReturnStmt n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(EnumDeclaration n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(EnumConstantDeclaration n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(InitializerDeclaration n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(IfStmt n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(WhileStmt n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(ContinueStmt n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(DoStmt n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(ForEachStmt n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(ForStmt n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(ThrowStmt n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(SynchronizedStmt n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(TryStmt n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(CatchClause n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(AnnotationDeclaration n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(AnnotationMemberDeclaration n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(MarkerAnnotationExpr n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(SingleMemberAnnotationExpr n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(NormalAnnotationExpr n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(MemberValuePair n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(LineComment n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(BlockComment n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(MarkdownComment n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(LambdaExpr n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(MethodReferenceExpr n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(TypeExpr n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(NodeList n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(ImportDeclaration n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(ModuleDeclaration n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(ModuleRequiresDirective n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(ModuleExportsDirective n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(ModuleProvidesDirective n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(ModuleUsesDirective n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(ModuleOpensDirective n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

visit

public void visit(UnparsableStmt n,
                  Void arg)

Specified by:

visit in interface VoidVisitor<Void>

printImports

protected void printImports(NodeList<ImportDeclaration> imports,
                            Void arg)

Print imports using an import ordering strategy. Orders imports using the selected ordering strategy, given by ORDER_IMPORTS (which forces alphabetic ordering if set), falling back to SORT_IMPORTS_STRATEGY (which yields a user-selected ordering), and finally to DefaultImportOrderingStrategy, and out them in groups, seperated by newlines.

printOrphanCommentsBeforeThisChildNode

protected void printOrphanCommentsBeforeThisChildNode(Node node)

Print all orphaned comments coming right before node.

printOrphanCommentsEnding

protected void printOrphanCommentsEnding(Node node)

Print all orphan comments coming at the end of the given node.

getOption

protected Optional<ConfigurationOption> getOption(DefaultPrinterConfiguration.ConfigOption cOption)

Get the value of a given configuration option.