KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > api > java > source > query > CommentHandler


1 /*
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8  *
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14  *
15  * The Original Software is NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */
19
20 package org.netbeans.api.java.source.query;
21
22 import com.sun.source.tree.Tree;
23 import org.netbeans.api.java.source.Comment;
24
25 /**
26  * The service that maps Trees with their associated comments.
27  *
28  * @see org.netbeans.modules.java.source.model.CommentSet
29  */
30 public interface CommentHandler {
31     
32     /**
33      * Returns true if the specified tree has an associated CommentSet.
34      */
35     boolean hasComments(Tree tree);
36     
37     /**
38      * Returns the CommentSet associated with a tree, or null if the tree
39      * does not have any comments.
40      */
41     CommentSet getComments(Tree tree);
42     
43     /**
44      * Copies preceding and trailing comments from one tree to another,
45      * appending the new entries to the existing comment lists.
46      */
47     void copyComments(Tree fromTree, Tree toTree);
48     
49     /**
50      * Add a preceding comment to a tree's comment set. If a comment set
51      * for the tree doesn't exist, one will be created.
52      */
53     void addComment(Tree tree, Comment c);
54 }
55
Popular Tags