View Javadoc
1   /*
2    * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved.
3    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4    *
5    * This code is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU General Public License version 2 only, as
7    * published by the Free Software Foundation.  Oracle designates this
8    * particular file as subject to the "Classpath" exception as provided
9    * by Oracle in the LICENSE file that accompanied this code.
10   *
11   * This code is distributed in the hope that it will be useful, but WITHOUT
12   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13   * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14   * version 2 for more details (a copy is included in the LICENSE file that
15   * accompanied this code).
16   *
17   * You should have received a copy of the GNU General Public License version
18   * 2 along with this work; if not, write to the Free Software Foundation,
19   * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20   *
21   * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22   * or visit www.oracle.com if you need additional information or have any
23   * questions.
24   */
25  package com.sun.tools.javac.tree;
26  
27  import com.sun.source.doctree.ErroneousTree;
28  import com.sun.tools.javac.parser.Tokens.Comment;
29  import com.sun.tools.javac.tree.DCTree.DCDocComment;
30  
31  /**
32   * A table giving the doc comment, if any, for any tree node.
33   *
34   *  <p><b>This is NOT part of any supported API.
35   *  If you write code that depends on this, you do so at your own
36   *  risk.  This code and its internal interfaces are subject to change
37   *  or deletion without notice.</b>
38   */
39  public interface DocCommentTable {
40      /**
41       * Check if a tree node has a corresponding doc comment.
42       */
43      public boolean hasComment(JCTree tree);
44  
45      /**
46       * Get the Comment token containing the doc comment, if any, for a tree node.
47       */
48      public Comment getComment(JCTree tree);
49  
50      /**
51       * Get the plain text of the doc comment, if any, for a tree node.
52       */
53      public String getCommentText(JCTree tree);
54  
55      /**
56       * Get the parsed form of the doc comment as a DocTree. If any errors
57       * are detected during parsing, they will be reported via
58       * {@link ErroneousTree ErroneousTree} nodes within the resulting tree.
59       */
60      public DCDocComment getCommentTree(JCTree tree);
61  
62      /**
63       * Set the Comment to be associated with a tree node.
64       */
65      public void putComment(JCTree tree, Comment c);
66  }