001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041: package org.netbeans.tax.spec;
042:
043: import org.netbeans.tax.TreeEntityDecl;
044: import org.netbeans.tax.TreeException;
045: import org.netbeans.tax.InvalidArgumentException;
046:
047: /**
048: *
049: * @author Libor Kramolis
050: * @version 0.1
051: */
052: public interface EntityDecl {
053:
054: //
055: // Constraints
056: //
057:
058: /**
059: *
060: */
061: public static interface Constraints {
062:
063: public void checkEntityDeclName(String name)
064: throws InvalidArgumentException;
065:
066: public boolean isValidEntityDeclName(String name);
067:
068: public void checkEntityDeclInternalText(String internalText)
069: throws InvalidArgumentException;
070:
071: public boolean isValidEntityDeclInternalText(String internalText);
072:
073: public void checkEntityDeclPublicId(String publicId)
074: throws InvalidArgumentException;
075:
076: public boolean isValidEntityDeclPublicId(String publicId);
077:
078: public void checkEntityDeclSystemId(String systemId)
079: throws InvalidArgumentException;
080:
081: public boolean isValidEntityDeclSystemId(String systemId);
082:
083: public void checkEntityDeclNotationName(String notationName)
084: throws InvalidArgumentException;
085:
086: public boolean isValidEntityDeclNotationName(String notationName);
087:
088: } // end: interface Constraints
089:
090: //
091: // Creator
092: //
093:
094: /**
095: *
096: */
097: public static interface Creator {
098:
099: /**
100: * @throws InvalidArgumentException
101: */
102: public TreeEntityDecl createEntityDecl(String name,
103: String internalText);
104:
105: /**
106: * @throws InvalidArgumentException
107: */
108: public TreeEntityDecl createEntityDecl(boolean parameter,
109: String name, String internalText);
110:
111: /**
112: * @throws InvalidArgumentException
113: */
114: public TreeEntityDecl createEntityDecl(String name,
115: String publicId, String systemId);
116:
117: /**
118: * @throws InvalidArgumentException
119: */
120: public TreeEntityDecl createEntityDecl(boolean parameter,
121: String name, String publicId, String systemId);
122:
123: /**
124: * @throws InvalidArgumentException
125: */
126: public TreeEntityDecl createEntityDecl(String name,
127: String publicId, String systemId, String notationName);
128:
129: } // end: interface Creator
130:
131: //
132: // Writer
133: //
134:
135: /**
136: *
137: */
138: public static interface Writer {
139:
140: public void writeEntityDecl(TreeEntityDecl entityDecl)
141: throws TreeException;
142:
143: } // end: interface Writer
144:
145: }
|