Top Description Methods
com.sun.org.apache.xerces.internal.xni.parser

public Interface XMLDocumentScanner

extends XMLDocumentSource
Known Direct Implementers
com.sun.org.apache.xerces.internal.impl.XMLDocumentFragmentScannerImpl
Imports
java.io.IOException, com.sun.org.apache.xerces.internal.xni.XNIException

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

Method Summary

Modifier and TypeMethod and Description
public int
next()

public boolean

Returns:

True if there is more to scan, false otherwise.
scanDocument
(boolean
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.
complete
)

Scans a document.

public void
setInputSource(XMLInputSource
The input source.
inputSource
)

Sets the input source.

Inherited from com.sun.org.apache.xerces.internal.xni.parser.XMLDocumentSource:
getDocumentHandlersetDocumentHandler

Method Detail

nextback to summary
public int next() throws XNIException, IOException
scanDocumentback to summary
public boolean scanDocument(boolean complete) throws IOException, XNIException

Scans a document.

Parameters
complete:boolean

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.

Returns:boolean

True if there is more to scan, false otherwise.

setInputSourceback to summary
public void setInputSource(XMLInputSource inputSource) throws IOException

Sets the input source.

Parameters
inputSource:XMLInputSource

The input source.

Exceptions
IOException:
Thrown on i/o error.