01: /*
02: * Sun Public License Notice
03: *
04: * The contents of this file are subject to the Sun Public License
05: * Version 1.0 (the "License"). You may not use this file except in
06: * compliance with the License. A copy of the License is available at
07: * http://www.sun.com/
08: *
09: * The Original Code is NetBeans. The Initial Developer of the Original
10: * Code is Sun Microsystems, Inc. Portions Copyright 1997-2000 Sun
11: * Microsystems, Inc. All Rights Reserved.
12: */
13: package org.netbeans.editor.ext.html.dtd;
14:
15: import java.io.Reader;
16: import java.util.Collection;
17:
18: /**
19: * DTDReaderProvider is interface used as a source of Readers used to parse DTD
20: * by DTDParser. One DTDReaderProvider shall offer all Readers for a given DTD,
21: * i.e. the provider for "-//W3C//DTD HTML 4.01//EN" shall also provide Readers
22: * for proper "-//W3C//ENTITIES Latin1//EN/HTML", as this public entity is
23: * referred from HTML 4.01 DTD and the file provided with 4.01 DTD differs from
24: * the file provided with 4.0 DTD although they have the same public identifier
25: * (They differ only in comments, though).
26: *
27: * @author Petr Nejedly
28: * @version 1.0
29: */
30: public interface ReaderProvider {
31:
32: /*
33: * Asks for Reader providing content of DTD file identified by given
34: * identifier, and possibly by given fileName. These parameters are
35: * typically obtained from invocation DTD directive like <!ENTITY %
36: * HTMLlat1 PUBLIC "-//W3C//ENTITIES Latin1//EN//HTML" "HTMLlat1.ent">, in
37: * this case, the string -//W3C//....//HTML" is identifier and
38: * "HTMLlat1.ent" is name of file in which it is probably stored @param
39: * identifier the public identifier of required DTD @param fileName the
40: * probable name of file with DTD data, may be <CODE>null</CODE>. It is
41: * used only as helper to identifier. @return Reader from which to read out
42: * the DTD content.
43: */
44: public Reader getReaderForIdentifier(String identifier,
45: String fileName);
46:
47: /**
48: * Asks for all the identifiers available from this ReaderProvider.
49: *
50: * @returns a Collection of all identifiers for which this ReaderProvider is
51: * able to provide Readers for.
52: */
53: public Collection getIdentifiers();
54: }
|