FileDocCategorySizeDatePackage
XMLDocumentScanner.javaAPI DocJava SE 6 API2541Tue Jun 10 00:22:54 BST 2008com.sun.org.apache.xerces.internal.xni.parser

XMLDocumentScanner

public interface XMLDocumentScanner implements XMLDocumentSource
This interface defines a generic document scanner. This interface allows a scanner to be used interchangably in existing parser configurations.

If the parser configuration uses a document scanner that implements this interface, components should be able to query the scanner instance from the component manager using the following property identifier:

"http://apache.org/xml/properties/internal/document-scanner"
author
Andy Clark, IBM
version
$Id: XMLDocumentScanner.java,v 1.2.6.2 2005/09/12 05:15:25 sunithareddy Exp $

Fields Summary
Constructors Summary
Methods Summary
public intnext()

public booleanscanDocument(boolean complete)
Scans a document.

param
complete True if the scanner should scan the document completely, pushing all events to the registered document handler. A value of false indicates that that the scanner should only scan the next portion of the document and return. A scanner instance is permitted to completely scan a document if it does not support this "pull" scanning model.
return
True if there is more to scan, false otherwise.

public voidsetInputSource(com.sun.org.apache.xerces.internal.xni.parser.XMLInputSource inputSource)
Sets the input source.

param
inputSource The input source.
throws
IOException Thrown on i/o error.