jjg@1280: /*
jjg@1280:  * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved.
jjg@1280:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
jjg@1280:  *
jjg@1280:  * This code is free software; you can redistribute it and/or modify it
jjg@1280:  * under the terms of the GNU General Public License version 2 only, as
jjg@1280:  * published by the Free Software Foundation.  Oracle designates this
jjg@1280:  * particular file as subject to the "Classpath" exception as provided
jjg@1280:  * by Oracle in the LICENSE file that accompanied this code.
jjg@1280:  *
jjg@1280:  * This code is distributed in the hope that it will be useful, but WITHOUT
jjg@1280:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
jjg@1280:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
jjg@1280:  * version 2 for more details (a copy is included in the LICENSE file that
jjg@1280:  * accompanied this code).
jjg@1280:  *
jjg@1280:  * You should have received a copy of the GNU General Public License version
jjg@1280:  * 2 along with this work; if not, write to the Free Software Foundation,
jjg@1280:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
jjg@1280:  *
jjg@1280:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
jjg@1280:  * or visit www.oracle.com if you need additional information or have any
jjg@1280:  * questions.
jjg@1280:  */
jjg@1280: package com.sun.tools.javac.tree;
jjg@1280: 
jjg@1409: import com.sun.source.doctree.ErroneousTree;
jjg@1280: import com.sun.tools.javac.parser.Tokens.Comment;
jjg@1409: import com.sun.tools.javac.tree.DCTree.DCDocComment;
jjg@1280: 
jjg@1280: /**
jjg@1280:  * A table giving the doc comment, if any, for any tree node.
jjg@1280:  *
jjg@1280:  *  <p><b>This is NOT part of any supported API.
jjg@1280:  *  If you write code that depends on this, you do so at your own
jjg@1280:  *  risk.  This code and its internal interfaces are subject to change
jjg@1280:  *  or deletion without notice.</b>
jjg@1280:  */
jjg@1280: public interface DocCommentTable {
jjg@1280:     /**
jjg@1280:      * Check if a tree node has a corresponding doc comment.
jjg@1280:      */
jjg@1280:     public boolean hasComment(JCTree tree);
jjg@1280: 
jjg@1280:     /**
jjg@1280:      * Get the Comment token containing the doc comment, if any, for a tree node.
jjg@1280:      */
jjg@1280:     public Comment getComment(JCTree tree);
jjg@1280: 
jjg@1280:     /**
jjg@1280:      * Get the plain text of the doc comment, if any, for a tree node.
jjg@1280:      */
jjg@1280:     public String getCommentText(JCTree tree);
jjg@1280: 
jjg@1280:     /**
jjg@1409:      * Get the parsed form of the doc comment as a DocTree. If any errors
jjg@1409:      * are detected during parsing, they will be reported via
jjg@1409:      * {@link ErroneousTree ErroneousTree} nodes within the resulting tree.
jjg@1409:      */
jjg@1409:     public DCDocComment getCommentTree(JCTree tree);
jjg@1409: 
jjg@1409:     /**
jjg@1280:      * Set the Comment to be associated with a tree node.
jjg@1280:      */
jjg@1280:     public void putComment(JCTree tree, Comment c);
jjg@1280: }