KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 2001, 2002 The Apache Software Foundation.
6  * All rights 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 import com.sun.org.apache.xerces.internal.xni.XNIException;
62
63 /**
64  * This interface defines a generic document scanner. This interface
65  * allows a scanner to be used interchangably in existing parser
66  * configurations.
67  * <p>
68  * If the parser configuration uses a document scanner that implements
69  * this interface, components should be able to query the scanner
70  * instance from the component manager using the following property
71  * identifier:
72  * <blockquote>
73  * "http://apache.org/xml/properties/internal/document-scanner"
74  * </blockquote>
75  *
76  * @author Andy Clark, IBM
77  *
78  * @version $Id: XMLDocumentScanner.java,v 1.4 2002/11/19 01:41:38 twl Exp $
79  */
80 public interface XMLDocumentScanner
81     extends XMLDocumentSource {
82
83     //
84 // XMLDocumentScanner methods
85 //
86
87     /**
88      * Sets the input source.
89      *
90      * @param inputSource The input source.
91      *
92      * @throws IOException Thrown on i/o error.
93      */
94     public void setInputSource(XMLInputSource inputSource) throws IOException JavaDoc;
95
96     /**
97      * Scans a document.
98      *
99      * @param complete True if the scanner should scan the document
100      * completely, pushing all events to the registered
101      * document handler. A value of false indicates that
102      * that the scanner should only scan the next portion
103      * of the document and return. A scanner instance is
104      * permitted to completely scan a document if it does
105      * not support this "pull" scanning model.
106      *
107      * @return True if there is more to scan, false otherwise.
108      */
109     public boolean scanDocument(boolean complete)
110         throws IOException JavaDoc, XNIException;
111
112 } // interface XMLDocumentScanner
113
Popular Tags