01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "License"). You may not use this file except in compliance with the
10: * License. You can obtain a copy of the License at
11: * http://www.netbeans.org/cddl-gplv2.html
12: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13: * specific language governing permissions and limitations under the
14: * License. When distributing the software, include this License Header
15: * Notice in each file and include the License file at
16: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17: * particular file as subject to the "Classpath" exception as provided
18: * by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the
20: * License Header, with the fields enclosed by brackets [] replaced by
21: * your own identifying information:
22: * "Portions Copyrighted [year] [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * The Original Software is NetBeans. The Initial Developer of the Original
27: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
28: * Microsystems, Inc. All Rights Reserved.
29: *
30: * If you wish your version of this file to be governed by only the CDDL
31: * or only the GPL Version 2, indicate your decision by adding
32: * "[Contributor] elects to include this software in this distribution
33: * under the [CDDL or GPL Version 2] license." If you do not indicate a
34: * single choice of license, a recipient has the option to distribute
35: * your version of this file under either the CDDL, the GPL Version 2 or
36: * to extend the choice of license to its licensees as provided above.
37: * However, if you add GPL Version 2 code and therefore, elected the GPL
38: * Version 2 license, then the option applies only if the new code is
39: * made subject to such option by the copyright holder.
40: */
41: package org.netbeans.editor.ext.html.dtd;
42:
43: import java.io.Reader;
44: import java.util.Collection;
45:
46: /**
47: * DTDReaderProvider is interface used as a source of Readers used to parse DTD
48: * by DTDParser. One DTDReaderProvider shall offer all Readers for a given DTD,
49: * i.e. the provider for "-//W3C//DTD HTML 4.01//EN" shall also provide Readers
50: * for proper "-//W3C//ENTITIES Latin1//EN/HTML", as this public entity is
51: * referred from HTML 4.01 DTD and the file provided with 4.01 DTD differs
52: * from the file provided with 4.0 DTD although they have the same
53: * public identifier (They differ only in comments, though).
54: *
55: * @author Petr Nejedly
56: * @version 1.0
57: */
58: public interface ReaderProvider {
59:
60: /* Asks for Reader providing content of DTD file identified by
61: * given identifier, and possibly by given fileName.
62: * These parameters are typically obtained from invocation DTD directive
63: * like <!ENTITY % HTMLlat1 PUBLIC "-//W3C//ENTITIES Latin1//EN//HTML" "HTMLlat1.ent">,
64: * in this case, the string -//W3C//....//HTML" is identifier
65: * and "HTMLlat1.ent" is name of file in which it is probably stored
66: * @param identifier the public identifier of required DTD
67: * @param fileName the probable name of file with DTD data, may be
68: * <CODE>null</CODE>. It is used only as helper to identifier.
69: * @return Reader from which to read out the DTD content.
70: */
71: public Reader getReaderForIdentifier(String identifier,
72: String fileName);
73:
74: /** Asks for all the identifiers available from this ReaderProvider.
75: * @returns a Collection of all identifiers for which this ReaderProvider
76: * is able to provide Readers for.
77: */
78: public Collection getIdentifiers();
79: }
|