Package com.sun.tools.javac.tree

Class DocPretty

java.lang.Object

com.sun.tools.javac.tree.DocPretty

All Implemented Interfaces:

DocTreeVisitor<Void,Void>

public class DocPretty
extends Object
implements DocTreeVisitor<Void,Void>

Prints out a doc comment tree.

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.

Constructor Summary

Constructors

Constructor and Description
DocPretty(Writer out)

Method Summary

Modifier and Type	Method and Description
void	print(DocTree tree) Visitor method: print expression tree.
void	print(List<? extends DocTree> list) Print list.
protected void	print(List<? extends DocTree> list, String sep) Print list., with separators
protected void	print(Object s) Print string, replacing all non-ascii character with unicode escapes.
protected void	println() Print new line.
protected void	printTagName(DocTree node)
Void	visitAttribute(AttributeTree node, Void p)
Void	visitAuthor(AuthorTree node, Void p)
Void	visitComment(CommentTree node, Void p)
Void	visitDeprecated(DeprecatedTree node, Void p)
Void	visitDocComment(DocCommentTree node, Void p)
Void	visitDocRoot(DocRootTree node, Void p)
Void	visitEndElement(EndElementTree node, Void p)
Void	visitEntity(EntityTree node, Void p)
Void	visitErroneous(ErroneousTree node, Void p)
Void	visitIdentifier(IdentifierTree node, Void p)
Void	visitInheritDoc(InheritDocTree node, Void p)
Void	visitLink(LinkTree node, Void p)
Void	visitLiteral(LiteralTree node, Void p)
Void	visitOther(DocTree node, Void p)
Void	visitParam(ParamTree node, Void p)
Void	visitReference(ReferenceTree node, Void p)
Void	visitReturn(ReturnTree node, Void p)
Void	visitSee(SeeTree node, Void p)
Void	visitSerial(SerialTree node, Void p)
Void	visitSerialData(SerialDataTree node, Void p)
Void	visitSerialField(SerialFieldTree node, Void p)
Void	visitSince(SinceTree node, Void p)
Void	visitStartElement(StartElementTree node, Void p)
Void	visitText(TextTree node, Void p)
Void	visitThrows(ThrowsTree node, Void p)
Void	visitUnknownBlockTag(UnknownBlockTagTree node, Void p)
Void	visitUnknownInlineTag(UnknownInlineTagTree node, Void p)
Void	visitValue(ValueTree node, Void p)
Void	visitVersion(VersionTree node, Void p)

Methods inherited from class java.lang.Object

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

Constructor Detail

DocPretty

public DocPretty(Writer out)

Method Detail

print

public void print(DocTree tree)
           throws IOException

Visitor method: print expression tree.

Throws:

IOException

print

protected void print(Object s)
              throws IOException

Print string, replacing all non-ascii character with unicode escapes.

Throws:

IOException

print

public void print(List<? extends DocTree> list)
           throws IOException

Print list.

Throws:

IOException

print

protected void print(List<? extends DocTree> list,
                     String sep)
              throws IOException

Print list., with separators

Throws:

IOException

println

protected void println()
                throws IOException

Print new line.

Throws:

IOException

printTagName

protected void printTagName(DocTree node)
                     throws IOException

Throws:

IOException

visitAttribute

public Void visitAttribute(AttributeTree node,
                           Void p)

Specified by:

visitAttribute in interface DocTreeVisitor<Void,Void>

visitAuthor

public Void visitAuthor(AuthorTree node,
                        Void p)

Specified by:

visitAuthor in interface DocTreeVisitor<Void,Void>

visitComment

public Void visitComment(CommentTree node,
                         Void p)

Specified by:

visitComment in interface DocTreeVisitor<Void,Void>

visitDeprecated

public Void visitDeprecated(DeprecatedTree node,
                            Void p)

Specified by:

visitDeprecated in interface DocTreeVisitor<Void,Void>

visitDocComment

public Void visitDocComment(DocCommentTree node,
                            Void p)

Specified by:

visitDocComment in interface DocTreeVisitor<Void,Void>

visitDocRoot

public Void visitDocRoot(DocRootTree node,
                         Void p)

Specified by:

visitDocRoot in interface DocTreeVisitor<Void,Void>

visitEndElement

public Void visitEndElement(EndElementTree node,
                            Void p)

Specified by:

visitEndElement in interface DocTreeVisitor<Void,Void>

visitEntity

public Void visitEntity(EntityTree node,
                        Void p)

Specified by:

visitEntity in interface DocTreeVisitor<Void,Void>

visitErroneous

public Void visitErroneous(ErroneousTree node,
                           Void p)

Specified by:

visitErroneous in interface DocTreeVisitor<Void,Void>

visitIdentifier

public Void visitIdentifier(IdentifierTree node,
                            Void p)

Specified by:

visitIdentifier in interface DocTreeVisitor<Void,Void>

visitInheritDoc

public Void visitInheritDoc(InheritDocTree node,
                            Void p)

Specified by:

visitInheritDoc in interface DocTreeVisitor<Void,Void>

visitLink

public Void visitLink(LinkTree node,
                      Void p)

Specified by:

visitLink in interface DocTreeVisitor<Void,Void>

visitLiteral

public Void visitLiteral(LiteralTree node,
                         Void p)

Specified by:

visitLiteral in interface DocTreeVisitor<Void,Void>

visitParam

public Void visitParam(ParamTree node,
                       Void p)

Specified by:

visitParam in interface DocTreeVisitor<Void,Void>

visitReference

public Void visitReference(ReferenceTree node,
                           Void p)

Specified by:

visitReference in interface DocTreeVisitor<Void,Void>

visitReturn

public Void visitReturn(ReturnTree node,
                        Void p)

Specified by:

visitReturn in interface DocTreeVisitor<Void,Void>

visitSee

public Void visitSee(SeeTree node,
                     Void p)

Specified by:

visitSee in interface DocTreeVisitor<Void,Void>

visitSerial

public Void visitSerial(SerialTree node,
                        Void p)

Specified by:

visitSerial in interface DocTreeVisitor<Void,Void>

visitSerialData

public Void visitSerialData(SerialDataTree node,
                            Void p)

Specified by:

visitSerialData in interface DocTreeVisitor<Void,Void>

visitSerialField

public Void visitSerialField(SerialFieldTree node,
                             Void p)

Specified by:

visitSerialField in interface DocTreeVisitor<Void,Void>

visitSince

public Void visitSince(SinceTree node,
                       Void p)

Specified by:

visitSince in interface DocTreeVisitor<Void,Void>

visitStartElement

public Void visitStartElement(StartElementTree node,
                              Void p)

Specified by:

visitStartElement in interface DocTreeVisitor<Void,Void>

visitText

public Void visitText(TextTree node,
                      Void p)

Specified by:

visitText in interface DocTreeVisitor<Void,Void>

visitThrows

public Void visitThrows(ThrowsTree node,
                        Void p)

Specified by:

visitThrows in interface DocTreeVisitor<Void,Void>

visitUnknownBlockTag

public Void visitUnknownBlockTag(UnknownBlockTagTree node,
                                 Void p)

Specified by:

visitUnknownBlockTag in interface DocTreeVisitor<Void,Void>

visitUnknownInlineTag

public Void visitUnknownInlineTag(UnknownInlineTagTree node,
                                  Void p)

Specified by:

visitUnknownInlineTag in interface DocTreeVisitor<Void,Void>

visitValue

public Void visitValue(ValueTree node,
                       Void p)

Specified by:

visitValue in interface DocTreeVisitor<Void,Void>

visitVersion

public Void visitVersion(VersionTree node,
                         Void p)

Specified by:

visitVersion in interface DocTreeVisitor<Void,Void>

visitOther

public Void visitOther(DocTree node,
                       Void p)

Specified by:

visitOther in interface DocTreeVisitor<Void,Void>