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

public Class DocPretty

extends Object
implements DocTreeVisitor<Void, Void>
Class Inheritance
All Implemented Interfaces
com.sun.source.doctree.DocTreeVisitor
Imports
java.io.IOException, .UncheckedIOException, .Writer, java.util.List, com.sun.source.doctree.*, .AttributeTree.ValueKind, com.sun.tools.javac.util.Convert, .DefinedBy, .DefinedBy.Api
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.

Field Summary

Modifier and TypeField and Description
pack-priv final String
lineSep

pack-priv final Writer
out

The output stream on which trees are printed.

Constructor Summary

AccessConstructor and Description
public
DocPretty(Writer out)

Method Summary

Modifier and TypeMethod and Description
protected void
println()

Print new line.

protected void
printTagName(DocTree node)

public Void
visitAttribute(AttributeTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitAttribute.

Visits an AttributeTree node.

public Void
visitAuthor(AuthorTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitAuthor.

Visits an AuthorTree node.

public Void
visitComment(CommentTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitComment.

Visits a CommentTree node.

public Void
visitDeprecated(DeprecatedTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitDeprecated.

Visits a DeprecatedTree node.

public Void
visitDocComment(DocCommentTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitDocComment.

Visits a DocCommentTree node.

public Void
visitDocRoot(DocRootTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitDocRoot.

Visits a DocRootTree node.

public Void
visitDocType(DocTypeTree node, Void p)

Overrides default com.sun.source.doctree.DocTreeVisitor.visitDocType.

Visits a DocTypeTree node.

public Void
visitEndElement(EndElementTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitEndElement.

Visits an EndElementTree node.

public Void
visitEntity(EntityTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitEntity.

Visits an EntityTree node.

public Void
visitErroneous(ErroneousTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitErroneous.

Visits an ErroneousTree node.

public Void
visitEscape(EscapeTree node, Void p)

Overrides default com.sun.source.doctree.DocTreeVisitor.visitEscape.

Visits an EscapeTree node.

public Void
visitHidden(HiddenTree node, Void p)

Overrides default com.sun.source.doctree.DocTreeVisitor.visitHidden.

Visits a HiddenTree node.

public Void
visitIdentifier(IdentifierTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitIdentifier.

Visits an IdentifierTree node.

public Void
visitIndex(IndexTree node, Void p)

Overrides default com.sun.source.doctree.DocTreeVisitor.visitIndex.

Visits an IndexTree node.

public Void
visitInheritDoc(InheritDocTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitInheritDoc.

Visits an InheritDocTree node.

public Void
visitLiteral(LiteralTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitLiteral.

Visits an LiteralTree node.

public Void
visitOther(DocTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitOther.

Visits an unknown type of DocTree node.

public Void
visitParam(ParamTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitParam.

Visits a ParamTree node.

public Void
visitProvides(ProvidesTree node, Void p)

Overrides default com.sun.source.doctree.DocTreeVisitor.visitProvides.

Visits a ProvidesTree node.

public Void
visitRawText(RawTextTree node, Void p)

Overrides default com.sun.source.doctree.DocTreeVisitor.visitRawText.

Visits a RawTextTree node.

public Void
visitReference(ReferenceTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitReference.

Visits a ReferenceTree node.

public Void
visitReturn(ReturnTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitReturn.

Visits a ReturnTree node.

public Void
visitSee(SeeTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitSee.

Visits a SeeTree node.

public Void
visitSerial(SerialTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitSerial.

Visits a SerialTree node.

public Void
visitSerialData(SerialDataTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitSerialData.

Visits a SerialDataTree node.

public Void
visitSerialField(SerialFieldTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitSerialField.

Visits a SerialFieldTree node.

public Void
visitSince(SinceTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitSince.

Visits a SinceTree node.

public Void
visitSnippet(SnippetTree node, Void p)

Overrides default com.sun.source.doctree.DocTreeVisitor.visitSnippet.

Visits a SnippetTree node.

public Void
visitSpec(SpecTree node, Void p)

Overrides default com.sun.source.doctree.DocTreeVisitor.visitSpec.

Visits a SpecTree node.

public Void
visitStartElement(StartElementTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitStartElement.

Visits a StartElementTree node.

public Void
visitSummary(SummaryTree node, Void p)

Overrides default com.sun.source.doctree.DocTreeVisitor.visitSummary.

Visits a SummaryTree node.

public Void
visitSystemProperty(SystemPropertyTree node, Void p)

Overrides default com.sun.source.doctree.DocTreeVisitor.visitSystemProperty.

Visits a SystemPropertyTree node.

public Void
visitText(TextTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitText.

Visits a TextTree node.

public Void
visitThrows(ThrowsTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitThrows.

Visits a ThrowsTree node.

public Void
visitUnknownBlockTag(UnknownBlockTagTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitUnknownBlockTag.

Visits an UnknownBlockTagTree node.

public Void
visitUnknownInlineTag(UnknownInlineTagTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitUnknownInlineTag.

Visits an UnknownInlineTagTree node.

public Void
visitUses(UsesTree node, Void p)

Overrides default com.sun.source.doctree.DocTreeVisitor.visitUses.

Visits a UsesTree node.

public Void
visitValue(ValueTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitValue.

Visits a ValueTree node.

public Void
visitVersion(VersionTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitVersion.

Visits a VersionTree node.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

lineSepback to summary
pack-priv final String lineSep
outback to summary
pack-priv final Writer out

The output stream on which trees are printed.

Constructor Detail

DocPrettyback to summary
public DocPretty(Writer out)

Method Detail

printback to summary
public void print(DocTree tree) throws IOException

Visitor method: print expression tree.

printback to summary
protected void print(Object s) throws IOException

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

printback to summary
private void print(char c) throws IOException

Print character. Should be only used internally for known ASCII characters.

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

Print list.

printback to summary
private void print(List<? extends DocTree> list, char sep) throws IOException

Print list with separators.

printlnback to summary
protected void println() throws IOException

Print new line.

printTagNameback to summary
protected void printTagName(DocTree node) throws IOException
visitAttributeback to summary
public Void visitAttribute(AttributeTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitAttribute.

Doc from com.sun.source.doctree.DocTreeVisitor.visitAttribute.

Visits an AttributeTree node.

Annotations
@Override
@DefinedBy:COMPILER_TREE
visitAuthorback to summary
public Void visitAuthor(AuthorTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitAuthor.

Doc from com.sun.source.doctree.DocTreeVisitor.visitAuthor.

Visits an AuthorTree node.

Annotations
@Override
@DefinedBy:COMPILER_TREE
visitCommentback to summary
public Void visitComment(CommentTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitComment.

Doc from com.sun.source.doctree.DocTreeVisitor.visitComment.

Visits a CommentTree node.

Annotations
@Override
@DefinedBy:COMPILER_TREE
visitDeprecatedback to summary
public Void visitDeprecated(DeprecatedTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitDeprecated.

Doc from com.sun.source.doctree.DocTreeVisitor.visitDeprecated.

Visits a DeprecatedTree node.

Annotations
@Override
@DefinedBy:COMPILER_TREE
visitDocCommentback to summary
public Void visitDocComment(DocCommentTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitDocComment.

Doc from com.sun.source.doctree.DocTreeVisitor.visitDocComment.

Visits a DocCommentTree node.

Annotations
@Override
@DefinedBy:COMPILER_TREE
visitDocRootback to summary
public Void visitDocRoot(DocRootTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitDocRoot.

Doc from com.sun.source.doctree.DocTreeVisitor.visitDocRoot.

Visits a DocRootTree node.

Annotations
@Override
@DefinedBy:COMPILER_TREE
visitDocTypeback to summary
public Void visitDocType(DocTypeTree node, Void p)

Overrides default com.sun.source.doctree.DocTreeVisitor.visitDocType.

Doc from com.sun.source.doctree.DocTreeVisitor.visitDocType.

Visits a DocTypeTree node.

Annotations
@Override
@DefinedBy:COMPILER_TREE
visitEndElementback to summary
public Void visitEndElement(EndElementTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitEndElement.

Doc from com.sun.source.doctree.DocTreeVisitor.visitEndElement.

Visits an EndElementTree node.

Annotations
@Override
@DefinedBy:COMPILER_TREE
visitEntityback to summary
public Void visitEntity(EntityTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitEntity.

Doc from com.sun.source.doctree.DocTreeVisitor.visitEntity.

Visits an EntityTree node.

Annotations
@Override
@DefinedBy:COMPILER_TREE
visitErroneousback to summary
public Void visitErroneous(ErroneousTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitErroneous.

Doc from com.sun.source.doctree.DocTreeVisitor.visitErroneous.

Visits an ErroneousTree node.

Annotations
@Override
@DefinedBy:COMPILER_TREE
visitEscapeback to summary
public Void visitEscape(EscapeTree node, Void p)

Overrides default com.sun.source.doctree.DocTreeVisitor.visitEscape.

Doc from com.sun.source.doctree.DocTreeVisitor.visitEscape.

Visits an EscapeTree node.

Annotations
@Override
@DefinedBy:COMPILER_TREE
visitHiddenback to summary
public Void visitHidden(HiddenTree node, Void p)

Overrides default com.sun.source.doctree.DocTreeVisitor.visitHidden.

Doc from com.sun.source.doctree.DocTreeVisitor.visitHidden.

Visits a HiddenTree node.

Annotations
@Override
@DefinedBy:COMPILER_TREE
visitIdentifierback to summary
public Void visitIdentifier(IdentifierTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitIdentifier.

Doc from com.sun.source.doctree.DocTreeVisitor.visitIdentifier.

Visits an IdentifierTree node.

Annotations
@Override
@DefinedBy:COMPILER_TREE
visitIndexback to summary
public Void visitIndex(IndexTree node, Void p)

Overrides default com.sun.source.doctree.DocTreeVisitor.visitIndex.

Doc from com.sun.source.doctree.DocTreeVisitor.visitIndex.

Visits an IndexTree node.

Annotations
@Override
@DefinedBy:COMPILER_TREE
visitInheritDocback to summary
public Void visitInheritDoc(InheritDocTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitInheritDoc.

Doc from com.sun.source.doctree.DocTreeVisitor.visitInheritDoc.

Visits an InheritDocTree node.

Annotations
@Override
@DefinedBy:COMPILER_TREE
visitLinkback to summary
public Void visitLink(LinkTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitLink.

Doc from com.sun.source.doctree.DocTreeVisitor.visitLink.

Visits a LinkTree node.

Annotations
@Override
@DefinedBy:COMPILER_TREE
visitLiteralback to summary
public Void visitLiteral(LiteralTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitLiteral.

Doc from com.sun.source.doctree.DocTreeVisitor.visitLiteral.

Visits an LiteralTree node.

Annotations
@Override
@DefinedBy:COMPILER_TREE
visitOtherback to summary
public Void visitOther(DocTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitOther.

Doc from com.sun.source.doctree.DocTreeVisitor.visitOther.

Visits an unknown type of DocTree node. This can occur if the set of tags evolves and new kinds of nodes are added to the DocTree hierarchy.

Annotations
@Override
@DefinedBy:COMPILER_TREE
visitParamback to summary
public Void visitParam(ParamTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitParam.

Doc from com.sun.source.doctree.DocTreeVisitor.visitParam.

Visits a ParamTree node.

Annotations
@Override
@DefinedBy:COMPILER_TREE
visitProvidesback to summary
public Void visitProvides(ProvidesTree node, Void p)

Overrides default com.sun.source.doctree.DocTreeVisitor.visitProvides.

Doc from com.sun.source.doctree.DocTreeVisitor.visitProvides.

Visits a ProvidesTree node.

Annotations
@Override
@DefinedBy:COMPILER_TREE
visitRawTextback to summary
public Void visitRawText(RawTextTree node, Void p)

Overrides default com.sun.source.doctree.DocTreeVisitor.visitRawText.

Doc from com.sun.source.doctree.DocTreeVisitor.visitRawText.

Visits a RawTextTree node.

Annotations
@Override
@DefinedBy:COMPILER_TREE
visitReferenceback to summary
public Void visitReference(ReferenceTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitReference.

Doc from com.sun.source.doctree.DocTreeVisitor.visitReference.

Visits a ReferenceTree node.

Annotations
@Override
@DefinedBy:COMPILER_TREE
visitReturnback to summary
public Void visitReturn(ReturnTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitReturn.

Doc from com.sun.source.doctree.DocTreeVisitor.visitReturn.

Visits a ReturnTree node.

Annotations
@Override
@DefinedBy:COMPILER_TREE
visitSeeback to summary
public Void visitSee(SeeTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitSee.

Doc from com.sun.source.doctree.DocTreeVisitor.visitSee.

Visits a SeeTree node.

Annotations
@Override
@DefinedBy:COMPILER_TREE
visitSerialback to summary
public Void visitSerial(SerialTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitSerial.

Doc from com.sun.source.doctree.DocTreeVisitor.visitSerial.

Visits a SerialTree node.

Annotations
@Override
@DefinedBy:COMPILER_TREE
visitSerialDataback to summary
public Void visitSerialData(SerialDataTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitSerialData.

Doc from com.sun.source.doctree.DocTreeVisitor.visitSerialData.

Visits a SerialDataTree node.

Annotations
@Override
@DefinedBy:COMPILER_TREE
visitSerialFieldback to summary
public Void visitSerialField(SerialFieldTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitSerialField.

Doc from com.sun.source.doctree.DocTreeVisitor.visitSerialField.

Visits a SerialFieldTree node.

Annotations
@Override
@DefinedBy:COMPILER_TREE
visitSinceback to summary
public Void visitSince(SinceTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitSince.

Doc from com.sun.source.doctree.DocTreeVisitor.visitSince.

Visits a SinceTree node.

Annotations
@Override
@DefinedBy:COMPILER_TREE
visitSnippetback to summary
public Void visitSnippet(SnippetTree node, Void p)

Overrides default com.sun.source.doctree.DocTreeVisitor.visitSnippet.

Doc from com.sun.source.doctree.DocTreeVisitor.visitSnippet.

Visits a SnippetTree node.

Annotations
@Override
@DefinedBy:COMPILER_TREE
visitSpecback to summary
public Void visitSpec(SpecTree node, Void p)

Overrides default com.sun.source.doctree.DocTreeVisitor.visitSpec.

Doc from com.sun.source.doctree.DocTreeVisitor.visitSpec.

Visits a SpecTree node.

Annotations
@Override
@DefinedBy:COMPILER_TREE
visitStartElementback to summary
public Void visitStartElement(StartElementTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitStartElement.

Doc from com.sun.source.doctree.DocTreeVisitor.visitStartElement.

Visits a StartElementTree node.

Annotations
@Override
@DefinedBy:COMPILER_TREE
visitSummaryback to summary
public Void visitSummary(SummaryTree node, Void p)

Overrides default com.sun.source.doctree.DocTreeVisitor.visitSummary.

Doc from com.sun.source.doctree.DocTreeVisitor.visitSummary.

Visits a SummaryTree node.

Annotations
@Override
@DefinedBy:COMPILER_TREE
visitSystemPropertyback to summary
public Void visitSystemProperty(SystemPropertyTree node, Void p)

Overrides default com.sun.source.doctree.DocTreeVisitor.visitSystemProperty.

Doc from com.sun.source.doctree.DocTreeVisitor.visitSystemProperty.

Visits a SystemPropertyTree node.

Annotations
@Override
@DefinedBy:COMPILER_TREE
visitTextback to summary
public Void visitText(TextTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitText.

Doc from com.sun.source.doctree.DocTreeVisitor.visitText.

Visits a TextTree node.

Annotations
@Override
@DefinedBy:COMPILER_TREE
visitThrowsback to summary
public Void visitThrows(ThrowsTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitThrows.

Doc from com.sun.source.doctree.DocTreeVisitor.visitThrows.

Visits a ThrowsTree node.

Annotations
@Override
@DefinedBy:COMPILER_TREE
visitUnknownBlockTagback to summary
public Void visitUnknownBlockTag(UnknownBlockTagTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitUnknownBlockTag.

Doc from com.sun.source.doctree.DocTreeVisitor.visitUnknownBlockTag.

Visits an UnknownBlockTagTree node.

Annotations
@Override
@DefinedBy:COMPILER_TREE
visitUnknownInlineTagback to summary
public Void visitUnknownInlineTag(UnknownInlineTagTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitUnknownInlineTag.

Doc from com.sun.source.doctree.DocTreeVisitor.visitUnknownInlineTag.

Visits an UnknownInlineTagTree node.

Annotations
@Override
@DefinedBy:COMPILER_TREE
visitUsesback to summary
public Void visitUses(UsesTree node, Void p)

Overrides default com.sun.source.doctree.DocTreeVisitor.visitUses.

Doc from com.sun.source.doctree.DocTreeVisitor.visitUses.

Visits a UsesTree node.

Annotations
@Override
@DefinedBy:COMPILER_TREE
visitValueback to summary
public Void visitValue(ValueTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitValue.

Doc from com.sun.source.doctree.DocTreeVisitor.visitValue.

Visits a ValueTree node.

Annotations
@Override
@DefinedBy:COMPILER_TREE
visitVersionback to summary
public Void visitVersion(VersionTree node, Void p)

Implements com.sun.source.doctree.DocTreeVisitor.visitVersion.

Doc from com.sun.source.doctree.DocTreeVisitor.visitVersion.

Visits a VersionTree node.

Annotations
@Override
@DefinedBy:COMPILER_TREE