Package com.sun.tools.javac.parser

Class LazyDocCommentTable

java.lang.Object

com.sun.tools.javac.parser.LazyDocCommentTable

All Implemented Interfaces:

DocCommentTable

public class LazyDocCommentTable
extends Object
implements DocCommentTable

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.

Method Summary

Modifier and Type	Method and Description
Tokens.Comment	getComment(JCTree tree) Get the Comment token containing the doc comment, if any, for a tree node.
String	getCommentText(JCTree tree) Get the plain text of the doc comment, if any, for a tree node.
DCTree.DCDocComment	getCommentTree(JCTree tree) Get the parsed form of the doc comment as a DocTree.
boolean	hasComment(JCTree tree) Check if a tree node has a corresponding doc comment.
void	putComment(JCTree tree, Tokens.Comment c) Set the Comment to be associated with a tree node.

Methods inherited from class java.lang.Object

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

Method Detail

hasComment

public boolean hasComment(JCTree tree)

Description copied from interface: DocCommentTable

Check if a tree node has a corresponding doc comment.

Specified by:

hasComment in interface DocCommentTable

getComment

public Tokens.Comment getComment(JCTree tree)

Description copied from interface: DocCommentTable

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

Specified by:

getComment in interface DocCommentTable

getCommentText

public String getCommentText(JCTree tree)

Description copied from interface: DocCommentTable

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

Specified by:

getCommentText in interface DocCommentTable

getCommentTree

public DCTree.DCDocComment getCommentTree(JCTree tree)

Description copied from interface: DocCommentTable

Get 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.

Specified by:

getCommentTree in interface DocCommentTable

putComment

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

Description copied from interface: DocCommentTable

Set the Comment to be associated with a tree node.

Specified by:

putComment in interface DocCommentTable