KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > util > xml > catalog > readers > CatalogReader


1 // CatalogReader.java - An interface for reading catalog files
2
3 /* ====================================================================
4  * The Apache Software License, Version 1.1
5  *
6  * Copyright (c) 2001-2003 The Apache Software Foundation. All rights
7  * reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  * notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  * notice, this list of conditions and the following disclaimer in
18  * the documentation and/or other materials provided with the
19  * distribution.
20  *
21  * 3. The end-user documentation included with the redistribution,
22  * if any, must include the following acknowledgment:
23  * "This product includes software developed by the
24  * Apache Software Foundation (http://www.apache.org/)."
25  * Alternately, this acknowledgment may appear in the software itself,
26  * if and wherever such third-party acknowledgments normally appear.
27  *
28  * 4. The names "Apache" and "Apache Software Foundation" must
29  * not be used to endorse or promote products derived from this
30  * software without prior written permission. For written
31  * permission, please contact apache@apache.org.
32  *
33  * 5. Products derived from this software may not be called "Apache",
34  * nor may "Apache" appear in their name, without prior written
35  * permission of the Apache Software Foundation.
36  *
37  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
41  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48  * SUCH DAMAGE.
49  * ====================================================================
50  *
51  * This software consists of voluntary contributions made by many
52  * individuals on behalf of the Apache Software Foundation. For more
53  * information on the Apache Software Foundation, please see
54  * <http://www.apache.org/>.
55  */
56
57 package org.jboss.util.xml.catalog.readers;
58
59 import java.io.IOException JavaDoc;
60 import java.net.MalformedURLException JavaDoc;
61
62 import java.io.InputStream JavaDoc;
63
64 import org.jboss.util.xml.catalog.Catalog;
65 import org.jboss.util.xml.catalog.CatalogException;
66
67 /**
68  * The CatalogReader interface.
69  *
70  * <p>The Catalog class requires that classes implement this interface
71  * in order to be used to read catalogs. Examples of CatalogReaders
72  * include the TextCatalogReader, the SAXCatalogReader, and the
73  * DOMCatalogReader.</p>
74  *
75  * @see Catalog
76  *
77  * @author Norman Walsh
78  * <a HREF="mailto:Norman.Walsh@Sun.COM">Norman.Walsh@Sun.COM</a>
79  *
80  * @version 1.0
81  */
82 public interface CatalogReader {
83     /**
84      * Read a catalog from a file.
85      *
86      * <p>This class reads a catalog from a URL.</p>
87      *
88      * @param catalog The catalog for which this reader is called.
89      * @param fileUrl The URL of a document to be read.
90      * @throws MalformedURLException if the specified URL cannot be
91      * turned into a URL object.
92      * @throws IOException if the URL cannot be read.
93      * @throws UnknownCatalogFormatException if the catalog format is
94      * not recognized.
95      * @throws UnparseableCatalogException if the catalog cannot be parsed.
96      * (For example, if it is supposed to be XML and isn't well-formed.)
97      */
98     public void readCatalog(Catalog catalog, String JavaDoc fileUrl)
99       throws MalformedURLException JavaDoc, IOException JavaDoc, CatalogException;
100
101     /**
102      * Read a catalog from an input stream.
103      *
104      * <p>This class reads a catalog from an input stream.</p>
105      *
106      * @param catalog The catalog for which this reader is called.
107      * @param is The input stream that is to be read.
108      * @throws IOException if the URL cannot be read.
109      * @throws UnknownCatalogFormatException if the catalog format is
110      * not recognized.
111      * @throws UnparseableCatalogException if the catalog cannot be parsed.
112      * (For example, if it is supposed to be XML and isn't well-formed.)
113      */
114     public void readCatalog(Catalog catalog, InputStream JavaDoc is)
115     throws IOException JavaDoc, CatalogException;
116 }
117
Popular Tags