KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > org > apache > xerces > internal > xni > parser > XMLEntityResolver


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 2001, 2002 The Apache Software Foundation. All rights
6  * reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Apache Software Foundation (http://www.apache.org/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Xerces" and "Apache Software Foundation" must
28  * not be used to endorse or promote products derived from this
29  * software without prior written permission. For written
30  * permission, please contact apache@apache.org.
31  *
32  * 5. Products derived from this software may not be called "Apache",
33  * nor may "Apache" appear in their name, without prior written
34  * permission of the Apache Software Foundation.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47  * SUCH DAMAGE.
48  * ====================================================================
49  *
50  * This software consists of voluntary contributions made by many
51  * individuals on behalf of the Apache Software Foundation and was
52  * originally based on software copyright (c) 1999, International
53  * Business Machines, Inc., http://www.apache.org. For more
54  * information on the Apache Software Foundation, please see
55  * <http://www.apache.org/>.
56  */
57
58 package com.sun.org.apache.xerces.internal.xni.parser;
59
60 import java.io.IOException JavaDoc;
61
62 import com.sun.org.apache.xerces.internal.xni.XNIException;
63 import com.sun.org.apache.xerces.internal.xni.XMLResourceIdentifier;
64
65 /**
66  * This interface is used to resolve external parsed entities. The
67  * application can register an object that implements this interface
68  * with the parser configuration in order to intercept entities and
69  * resolve them explicitly. If the registered entity resolver cannot
70  * resolve the entity, it should return <code>null</code> so that the
71  * parser will try to resolve the entity using a default mechanism.
72  *
73  * @see XMLParserConfiguration
74  *
75  * @author Andy Clark, IBM
76  *
77  * @version $Id: XMLEntityResolver.java,v 1.4 2002/01/29 01:15:19 lehors Exp $
78  */
79 public interface XMLEntityResolver {
80
81     //
82 // XMLEntityResolver methods
83 //
84
85     /**
86      * Resolves an external parsed entity. If the entity cannot be
87      * resolved, this method should return null.
88      *
89      * @param resourceIdentifier: location of the XML resource to resolve
90      *
91      * @throws XNIException Thrown on general error.
92      * @throws IOException Thrown if resolved entity stream cannot be
93      * opened or some other i/o error occurs.
94      * @see com.sun.org.apache.xerces.internal.xni.XMLResourceIdentifier
95      */
96     public XMLInputSource resolveEntity(XMLResourceIdentifier resourceIdentifier)
97         throws XNIException, IOException JavaDoc;
98
99 } // interface XMLEntityResolver
100
Popular Tags