001: /*
002: * The Apache Software License, Version 1.1
003: *
004: *
005: * Copyright (c) 2001, 2002 The Apache Software Foundation.
006: * All rights reserved.
007: *
008: * Redistribution and use in source and binary forms, with or without
009: * modification, are permitted provided that the following conditions
010: * are met:
011: *
012: * 1. Redistributions of source code must retain the above copyright
013: * notice, this list of conditions and the following disclaimer.
014: *
015: * 2. Redistributions in binary form must reproduce the above copyright
016: * notice, this list of conditions and the following disclaimer in
017: * the documentation and/or other materials provided with the
018: * distribution.
019: *
020: * 3. The end-user documentation included with the redistribution,
021: * if any, must include the following acknowledgment:
022: * "This product includes software developed by the
023: * Apache Software Foundation (http://www.apache.org/)."
024: * Alternately, this acknowledgment may appear in the software itself,
025: * if and wherever such third-party acknowledgments normally appear.
026: *
027: * 4. The names "Xerces" and "Apache Software Foundation" must
028: * not be used to endorse or promote products derived from this
029: * software without prior written permission. For written
030: * permission, please contact apache@apache.org.
031: *
032: * 5. Products derived from this software may not be called "Apache",
033: * nor may "Apache" appear in their name, without prior written
034: * permission of the Apache Software Foundation.
035: *
036: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
037: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
038: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
039: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
040: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
041: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
042: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
043: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
044: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
045: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
046: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
047: * SUCH DAMAGE.
048: * ====================================================================
049: *
050: * This software consists of voluntary contributions made by many
051: * individuals on behalf of the Apache Software Foundation and was
052: * originally based on software copyright (c) 1999, International
053: * Business Machines, Inc., http://www.apache.org. For more
054: * information on the Apache Software Foundation, please see
055: * <http://www.apache.org/>.
056: */
057:
058: package com.sun.xml.stream.xerces.xni.parser;
059:
060: import java.io.IOException;
061:
062: import com.sun.xml.stream.xerces.xni.XNIException;
063:
064: /**
065: * This interface defines a generic document scanner. This interface
066: * allows a scanner to be used interchangably in existing parser
067: * configurations.
068: * <p>
069: * If the parser configuration uses a document scanner that implements
070: * this interface, components should be able to query the scanner
071: * instance from the component manager using the following property
072: * identifier:
073: * <blockquote>
074: * "http://apache.org/xml/properties/internal/document-scanner"
075: * </blockquote>
076: *
077: * @author Andy Clark, IBM
078: *
079: * @version $Id: XMLDocumentScanner.java,v 1.2 2006/04/01 06:01:44 jeffsuttor Exp $
080: */
081: public interface XMLDocumentScanner extends XMLDocumentSource {
082:
083: //
084: // XMLDocumentScanner methods
085: //
086:
087: /**
088: * Sets the input source.
089: *
090: * @param inputSource The input source.
091: *
092: * @throws IOException Thrown on i/o error.
093: */
094: public void setInputSource(XMLInputSource inputSource)
095: throws IOException;
096:
097: /**
098: * Scans a document.
099: *
100: * @param complete True if the scanner should scan the document
101: * completely, pushing all events to the registered
102: * document handler. A value of false indicates that
103: * that the scanner should only scan the next portion
104: * of the document and return. A scanner instance is
105: * permitted to completely scan a document if it does
106: * not support this "pull" scanning model.
107: *
108: * @returns True if there is more to scan, false otherwise.
109: */
110: public boolean scanDocument(boolean complete) throws IOException,
111: XNIException;
112:
113: public int next() throws IOException, XNIException;
114:
115: } // interface XMLDocumentScanner
|