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

public Class LazyDocCommentTable

extends Object
implements DocCommentTable
Class Inheritance
All Implemented Interfaces
com.sun.tools.javac.tree.DocCommentTable
Imports
java.util.HashMap, .Map, javax.lang.model.util.Elements.DocCommentKind, com.sun.source.doctree.DocCommentTree, com.sun.tools.javac.parser.Tokens.Comment, com.sun.tools.javac.tree.DocCommentTable, .JCTree, com.sun.tools.javac.util.DiagnosticSource

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.

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
LazyDocCommentTable.Entry

Field Summary

Modifier and TypeField and Description
private final DiagnosticSource
diagSource

private final ParserFactory
fac

private final Map<JCTree, LazyDocCommentTable.Entry>
table

Constructor Summary

AccessConstructor and Description
pack-priv
LazyDocCommentTable(ParserFactory fac)

Method Summary

Modifier and TypeMethod and Description
public Tokens.Comment
getComment(JCTree tree)

Implements com.sun.tools.javac.tree.DocCommentTable.getComment.

Returns the Comment token containing the doc comment, if any, for a tree node.

public Elements.DocCommentKind
getCommentKind(JCTree tree)

Implements com.sun.tools.javac.tree.DocCommentTable.getCommentKind.

Returns the kind of the doc comment, if any, for a tree node.

public String
getCommentText(JCTree tree)

Implements com.sun.tools.javac.tree.DocCommentTable.getCommentText.

Returns the plain text of the doc comment, if any, for a tree node.

public DocCommentTree
getCommentTree(JCTree tree)

Implements com.sun.tools.javac.tree.DocCommentTable.getCommentTree.

Returns the parsed form of the doc comment as a DocTree.

public boolean
hasComment(JCTree tree)

Implements com.sun.tools.javac.tree.DocCommentTable.hasComment.

Checks if a tree node has a corresponding doc comment.

public void
putComment(JCTree tree, Tokens.Comment c)

Implements com.sun.tools.javac.tree.DocCommentTable.putComment.

Sets the Comment to be associated with a tree node.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

diagSourceback to summary
private final DiagnosticSource diagSource
facback to summary
private final ParserFactory fac
tableback to summary
private final Map<JCTree, LazyDocCommentTable.Entry> table

Constructor Detail

LazyDocCommentTableback to summary
pack-priv LazyDocCommentTable(ParserFactory fac)

Method Detail

getCommentback to summary
public Tokens.Comment getComment(JCTree tree)

Implements com.sun.tools.javac.tree.DocCommentTable.getComment.

Doc from com.sun.tools.javac.tree.DocCommentTable.getComment.

Returns the Comment token containing the doc comment, if any, for a tree node.

Annotations
@Override
getCommentKindback to summary
public Elements.DocCommentKind getCommentKind(JCTree tree)

Implements com.sun.tools.javac.tree.DocCommentTable.getCommentKind.

Doc from com.sun.tools.javac.tree.DocCommentTable.getCommentKind.

Returns the kind of the doc comment, if any, for a tree node.

Annotations
@Override
getCommentTextback to summary
public String getCommentText(JCTree tree)

Implements com.sun.tools.javac.tree.DocCommentTable.getCommentText.

Doc from com.sun.tools.javac.tree.DocCommentTable.getCommentText.

Returns the plain text of the doc comment, if any, for a tree node.

Annotations
@Override
getCommentTreeback to summary
public DocCommentTree getCommentTree(JCTree tree)

Implements com.sun.tools.javac.tree.DocCommentTable.getCommentTree.

Doc from com.sun.tools.javac.tree.DocCommentTable.getCommentTree.

Returns the parsed form of the doc comment as a DocTree. If any errors are detected during parsing, they will be reported via ErroneousTree nodes within the resulting tree.

Annotations
@Override
hasCommentback to summary
public boolean hasComment(JCTree tree)

Implements com.sun.tools.javac.tree.DocCommentTable.hasComment.

Doc from com.sun.tools.javac.tree.DocCommentTable.hasComment.

Checks if a tree node has a corresponding doc comment.

Annotations
@Override
putCommentback to summary
public void putComment(JCTree tree, Tokens.Comment c)

Implements com.sun.tools.javac.tree.DocCommentTable.putComment.

Doc from com.sun.tools.javac.tree.DocCommentTable.putComment.

Sets the Comment to be associated with a tree node.

Annotations
@Override
com.sun.tools.javac.parser back to summary

private Class LazyDocCommentTable.Entry

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
pack-priv final Tokens.Comment
comment

pack-priv DocCommentTree
tree

Constructor Summary

AccessConstructor and Description
pack-priv
Entry(Tokens.Comment c)

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

commentback to summary
pack-priv final Tokens.Comment comment
treeback to summary
pack-priv DocCommentTree tree

Constructor Detail

Entryback to summary
pack-priv Entry(Tokens.Comment c)