protected class

XMLDocumentScannerImpl.ContentDispatcher

extends XMLDocumentFragmentScannerImpl.FragmentContentDispatcher
java.lang.Object
   ↳ org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.FragmentContentDispatcher
     ↳ org.apache.xerces.impl.XMLDocumentScannerImpl.ContentDispatcher
Known Direct Subclasses

Class Overview

Dispatcher to handle content scanning.

Summary

Protected Constructors
XMLDocumentScannerImpl.ContentDispatcher()
Protected Methods
boolean elementDepthIsZeroHook()
Element depth iz zero.
void endOfFileHook(EOFException e)
End of file hook.
void resolveExternalSubsetAndRead()

Attempt to locate an external subset for a document that does not otherwise have one.

boolean scanForDoctypeHook()
Scan for DOCTYPE hook.
boolean scanRootElementHook()
Scan for root element hook.
[Expand]
Inherited Methods
From class org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.FragmentContentDispatcher
From class java.lang.Object
From interface org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.Dispatcher

Protected Constructors

protected XMLDocumentScannerImpl.ContentDispatcher ()

Protected Methods

protected boolean elementDepthIsZeroHook ()

Element depth iz zero. This methos is a hook for subclasses to add code to handle when the element depth hits zero. When scanning a document fragment, an element depth of zero is normal. However, when scanning a full XML document, the scanner must handle the trailing miscellanous section of the document after the end of the document's root element.

Returns
  • True if the caller should stop and return true which allows the scanner to switch to a new scanning dispatcher. A return value of false indicates that the content dispatcher should continue as normal.
Throws
IOException
XNIException

protected void endOfFileHook (EOFException e)

End of file hook. This method is a hook for subclasses to add code that handles the end of file. The end of file in a document fragment is OK if the markup depth is zero. However, when scanning a full XML document, an end of file is always premature.

Throws
IOException
XNIException

protected void resolveExternalSubsetAndRead ()

Attempt to locate an external subset for a document that does not otherwise have one. If an external subset is located, then it is scanned.

Throws
IOException
XNIException

protected boolean scanForDoctypeHook ()

Scan for DOCTYPE hook. This method is a hook for subclasses to add code to handle scanning for a the "DOCTYPE" string after the string "

Returns
  • True if the "DOCTYPE" was scanned; false if "DOCTYPE" was not scanned.
Throws
IOException
XNIException

protected boolean scanRootElementHook ()

Scan for root element hook. This method is a hook for subclasses to add code that handles scanning for the root element. When scanning a document fragment, there is no "root" element. However, when scanning a full XML document, the scanner must handle the root element specially.

Returns
  • True if the caller should stop and return true which allows the scanner to switch to a new scanning dispatcher. A return value of false indicates that the content dispatcher should continue as normal.
Throws
IOException
XNIException