KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > org > apache > xerces > internal > impl > XMLEntityHandler


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 2000-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.impl;
59
60 import com.sun.org.apache.xerces.internal.xni.Augmentations;
61 import com.sun.org.apache.xerces.internal.xni.XMLResourceIdentifier;
62 import com.sun.org.apache.xerces.internal.xni.XNIException;
63
64 /**
65  * The entity handler interface defines methods to report information
66  * about the start and end of entities.
67  *
68  * @see com.sun.org.apache.xerces.internal.impl.XMLEntityScanner
69  *
70  * @author Andy Clark, IBM
71  *
72  * @version $Id: XMLEntityHandler.java,v 1.9 2004/02/27 20:36:07 mrglavas Exp $
73  */
74 public interface XMLEntityHandler {
75
76     //
77 // XMLEntityHandler methods
78 //
79
80     /**
81      * This method notifies of the start of an entity. The DTD has the
82      * pseudo-name of "[dtd]" parameter entity names start with '%'; and
83      * general entities are just specified by their name.
84      *
85      * @param name The name of the entity.
86      * @param identifier The resource identifier.
87      * @param encoding The auto-detected IANA encoding name of the entity
88      * stream. This value will be null in those situations
89      * where the entity encoding is not auto-detected (e.g.
90      * internal entities or a document entity that is
91      * parsed from a java.io.Reader).
92      * @param augs Additional information that may include infoset augmentations
93      *
94      * @throws XNIException Thrown by handler to signal an error.
95      */
96     public void startEntity(String JavaDoc name,
97                             XMLResourceIdentifier identifier,
98                             String JavaDoc encoding, Augmentations augs) throws XNIException;
99
100     /**
101      * This method notifies the end of an entity. The DTD has the pseudo-name
102      * of "[dtd]" parameter entity names start with '%'; and general entities
103      * are just specified by their name.
104      *
105      * @param name The name of the entity.
106      * @param augs Additional information that may include infoset augmentations
107      *
108      * @throws XNIException Thrown by handler to signal an error.
109      */
110     public void endEntity(String JavaDoc name, Augmentations augs) throws XNIException;
111
112 } // interface XMLEntityHandler
113
Popular Tags