KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > tax > spec > Comment


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-2006 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */
19 package org.netbeans.tax.spec;
20
21 import org.netbeans.tax.TreeComment;
22 import org.netbeans.tax.TreeException;
23 import org.netbeans.tax.InvalidArgumentException;
24
25 /**
26  *
27  * @author Libor Kramolis
28  * @version 0.1
29  */
30 public interface Comment {
31
32     //
33 // Constraints
34 //
35
36     /**
37      *
38      */
39     public static interface Constraints {
40
41         public void checkCommentData (String JavaDoc data) throws InvalidArgumentException;
42
43         public boolean isValidCommentData (String JavaDoc data);
44
45     } // end: interface Constraints
46
47     
48     //
49 // Creator
50 //
51
52     /**
53      *
54      */
55     public static interface Creator {
56         
57         /**
58          * @throws InvalidArgumentException
59          */
60         public TreeComment createComment (String JavaDoc data);
61         
62     } // end: interface Creator
63
64     
65     //
66 // Writer
67 //
68
69     /**
70      *
71      */
72     public static interface Writer {
73         
74         public void writeComment (TreeComment comment) throws TreeException;
75         
76     } // end: interface Writer
77
78 }
79
Popular Tags