KickJava   Java API By Example, From Geeks To Geeks.

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


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
64 /**
65  * Represents a parser configuration that can be used as the
66  * configuration for a "pull" parser. A pull parser allows the
67  * application to drive the parser instead of having document
68  * information events "pushed" to the registered handlers.
69  * <p>
70  * A pull parser using this type of configuration first calls
71  * the <code>setInputSource</code> method. After the input
72  * source is set, the pull parser repeatedly calls the
73  * <code>parse(boolean):boolean</code> method. This method
74  * returns a value of true if there is more to parse in the
75  * document.
76  * <p>
77  * Calling the <code>parse(XMLInputSource)</code> is equivalent
78  * to setting the input source and calling the
79  * <code>parse(boolean):boolean</code> method with a "complete"
80  * value of <code>true</code>.
81  *
82  * @author Andy Clark, IBM
83  *
84  * @version $Id: XMLPullParserConfiguration.java,v 1.5 2002/11/19 01:41:38 twl Exp $
85  */
86 public interface XMLPullParserConfiguration
87     extends XMLParserConfiguration {
88
89     //
90 // XMLPullParserConfiguration methods
91 //
92
93     // parsing
94
95     /**
96      * Sets the input source for the document to parse.
97      *
98      * @param inputSource The document's input source.
99      *
100      * @exception XMLConfigurationException Thrown if there is a
101      * configuration error when initializing the
102      * parser.
103      * @exception IOException Thrown on I/O error.
104      *
105      * @see #parse(boolean)
106      */
107     public void setInputSource(XMLInputSource inputSource)
108         throws XMLConfigurationException, IOException JavaDoc;
109
110     /**
111      * Parses the document in a pull parsing fashion.
112      *
113      * @param complete True if the pull parser should parse the
114      * remaining document completely.
115      *
116      * @return True if there is more document to parse.
117      *
118      * @exception XNIException Any XNI exception, possibly wrapping
119      * another exception.
120      * @exception IOException An IO exception from the parser, possibly
121      * from a byte stream or character stream
122      * supplied by the parser.
123      *
124      * @see #setInputSource
125      */
126     public boolean parse(boolean complete) throws XNIException, IOException JavaDoc;
127
128     /**
129      * If the application decides to terminate parsing before the xml document
130      * is fully parsed, the application should call this method to free any
131      * resource allocated during parsing. For example, close all opened streams.
132      */
133     public void cleanup();
134     
135 } // interface XMLPullParserConfiguration
136
Popular Tags