KickJava   Java API By Example, From Geeks To Geeks.

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


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.TreeEntityDecl;
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 EntityDecl {
31
32     //
33 // Constraints
34 //
35
36     /**
37      *
38      */
39     public static interface Constraints {
40
41         public void checkEntityDeclName (String JavaDoc name) throws InvalidArgumentException;
42
43         public boolean isValidEntityDeclName (String JavaDoc name);
44
45
46         public void checkEntityDeclInternalText (String JavaDoc internalText) throws InvalidArgumentException;
47         
48         public boolean isValidEntityDeclInternalText (String JavaDoc internalText);
49         
50         
51         public void checkEntityDeclPublicId (String JavaDoc publicId) throws InvalidArgumentException;
52         
53         public boolean isValidEntityDeclPublicId (String JavaDoc publicId);
54         
55         
56         public void checkEntityDeclSystemId (String JavaDoc systemId) throws InvalidArgumentException;
57         
58         public boolean isValidEntityDeclSystemId (String JavaDoc systemId);
59         
60         
61         public void checkEntityDeclNotationName (String JavaDoc notationName) throws InvalidArgumentException;
62         
63         public boolean isValidEntityDeclNotationName (String JavaDoc notationName);
64         
65     } // end: interface Constraints
66
67     
68     //
69 // Creator
70 //
71
72     /**
73      *
74      */
75     public static interface Creator {
76         
77         /**
78          * @throws InvalidArgumentException
79          */
80         public TreeEntityDecl createEntityDecl (String JavaDoc name, String JavaDoc internalText);
81         
82         /**
83          * @throws InvalidArgumentException
84          */
85         public TreeEntityDecl createEntityDecl (boolean parameter, String JavaDoc name, String JavaDoc internalText);
86         
87         /**
88          * @throws InvalidArgumentException
89          */
90         public TreeEntityDecl createEntityDecl (String JavaDoc name, String JavaDoc publicId, String JavaDoc systemId);
91         
92         /**
93          * @throws InvalidArgumentException
94          */
95         public TreeEntityDecl createEntityDecl (boolean parameter, String JavaDoc name, String JavaDoc publicId, String JavaDoc systemId);
96         
97         /**
98          * @throws InvalidArgumentException
99          */
100         public TreeEntityDecl createEntityDecl (String JavaDoc name, String JavaDoc publicId, String JavaDoc systemId, String JavaDoc notationName);
101         
102     } // end: interface Creator
103
104     
105     //
106 // Writer
107 //
108
109     /**
110      *
111      */
112     public static interface Writer {
113         
114         public void writeEntityDecl (TreeEntityDecl entityDecl) throws TreeException;
115         
116     } // end: interface Writer
117
118 }
119
Popular Tags