Top Description Inners Fields Constructors Methods
org.apache.xerces.impl

public Class XMLDocumentScannerImpl

extends XMLDocumentFragmentScannerImpl
Class Inheritance
Known Direct Subclasses
org.apache.xerces.impl.XMLNSDocumentScannerImpl, org.apache.xerces.impl.XML11DocumentScannerImpl
Imports
java.io.CharConversionException, .EOFException, .IOException, org.apache.xerces.impl.dtd.XMLDTDDescription, org.apache.xerces.impl.io.MalformedByteSequenceException, org.apache.xerces.impl.msg.XMLMessageFormatter, org.apache.xerces.impl.validation.ValidationManager, org.apache.xerces.util.NamespaceSupport, .XMLChar, .XMLStringBuffer, org.apache.xerces.xni.Augmentations, .NamespaceContext, .XMLResourceIdentifier, .XMLString, .XNIException, org.apache.xerces.xni.parser.XMLComponentManager, .XMLConfigurationException, .XMLDTDScanner, .XMLInputSource
This class is responsible for scanning XML document structure and content. The scanner acts as the source for the document information which is communicated to the document handler.

This component requires the following features and properties from the component manager that uses it:

Authors
Glenn Marcy, IBM, Andy Clark, IBM, Arnaud Le Hors, IBM, Eric Ye, IBM
Version
$Id: XMLDocumentScannerImpl.java 572055 2007-09-02 17:55:43Z mrglavas $

Nested and Inner Type Summary

Modifier and TypeClass and Description
protected class
XMLDocumentScannerImpl.ContentDispatcher

Dispatcher to handle content scanning.

protected class
XMLDocumentScannerImpl.DTDDispatcher

Dispatcher to handle the internal and external DTD subsets.

protected class
XMLDocumentScannerImpl.PrologDispatcher

Dispatcher to handle prolog scanning.

protected class
XMLDocumentScannerImpl.TrailingMiscDispatcher

Dispatcher to handle trailing miscellaneous section scanning.

protected class
XMLDocumentScannerImpl.XMLDeclDispatcher

Dispatcher to handle XMLDecl scanning.

Field Summary

Modifier and TypeField and Description
protected static final String
DISALLOW_DOCTYPE_DECL_FEATURE

Feature identifier: load external DTD.

protected static final String
DTD_SCANNER

Property identifier: DTD scanner.

protected boolean
fDisallowDoctype

Disallow doctype declaration.

protected String
fDoctypeName

Doctype name.

protected String
fDoctypePublicId

Doctype declaration public identifier.

protected String
fDoctypeSystemId

Doctype declaration system identifier.

private final XMLDTDDescription
fDTDDescription

A DTD Description.

protected final XMLDocumentFragmentScannerImpl.Dispatcher
fDTDDispatcher

DTD dispatcher.

protected XMLDTDScanner
fDTDScanner

DTD scanner.

private static final Boolean[]
FEATURE_DEFAULTS

Hides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.FEATURE_DEFAULTS.

Feature defaults.
private XMLInputSource
fExternalSubsetSource

External subset source.

protected boolean
fLoadExternalDTD

Load external DTD.

protected NamespaceContext
fNamespaceContext

Namespace support.

protected final XMLDocumentFragmentScannerImpl.Dispatcher
fPrologDispatcher

Prolog dispatcher.

protected boolean
fScanningDTD

Scanning DTD.

protected boolean
fSeenDoctypeDecl

Seen doctype declaration.

private final XMLString
fString

Hides org.apache.xerces.impl.XMLScanner.fString.

String.
private final XMLStringBuffer
fStringBuffer

Hides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.fStringBuffer.

String buffer.
private final String[]
fStrings

Hides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.fStrings.

Array of 3 strings.
protected final XMLDocumentFragmentScannerImpl.Dispatcher
fTrailingMiscDispatcher

Trailing miscellaneous section dispatcher.

protected ValidationManager
fValidationManager

Validation manager .

protected final XMLDocumentFragmentScannerImpl.Dispatcher
fXMLDeclDispatcher

XML declaration dispatcher.

protected static final String
LOAD_EXTERNAL_DTD

Feature identifier: load external DTD.

protected static final String
NAMESPACE_CONTEXT

property identifier: NamespaceContext

private static final Object[]
PROPERTY_DEFAULTS

Hides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.PROPERTY_DEFAULTS.

Property defaults.
private static final String[]
RECOGNIZED_FEATURES

Hides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.RECOGNIZED_FEATURES.

Recognized features.
private static final String[]
RECOGNIZED_PROPERTIES

Hides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.RECOGNIZED_PROPERTIES.

Recognized properties.
protected static final int
SCANNER_STATE_DTD_EXTERNAL

Scanner state: open DTD external subset.

protected static final int
SCANNER_STATE_DTD_EXTERNAL_DECLS

Scanner state: DTD external declarations.

protected static final int
SCANNER_STATE_DTD_INTERNAL_DECLS

Scanner state: DTD internal declarations.

protected static final int
SCANNER_STATE_PROLOG

Scanner state: prolog.

protected static final int
SCANNER_STATE_TRAILING_MISC

Scanner state: trailing misc.

protected static final int
SCANNER_STATE_XML_DECL

Scanner state: XML declaration.

protected static final String
VALIDATION_MANAGER

property identifier: ValidationManager

Inherited from org.apache.xerces.impl.XMLDocumentFragmentScannerImpl:
DEBUG_CONTENT_SCANNINGENTITY_RESOLVERfAttributeQNamefAttributesfContentDispatcherfCurrentElementfDispatcherfDocumentHandlerfElementQNamefElementStackfEntityStackfExternalSubsetResolverfHasExternalDTDfInScanContentfIsEntityDeclaredVCfMarkupDepthfNotifyBuiltInRefsfScannerStatefStandalonefTempStringfTempString2NAMESPACESNOTIFY_BUILTIN_REFSSCANNER_STATE_CDATASCANNER_STATE_COMMENTSCANNER_STATE_CONTENTSCANNER_STATE_DOCTYPESCANNER_STATE_END_OF_INPUTSCANNER_STATE_PISCANNER_STATE_REFERENCESCANNER_STATE_ROOT_ELEMENTSCANNER_STATE_START_OF_MARKUPSCANNER_STATE_TERMINATEDSCANNER_STATE_TEXT_DECL

Constructor Summary

AccessConstructor and Description
public
XMLDocumentScannerImpl()

Default constructor.

Method Summary

Modifier and TypeMethod and Description
protected XMLDocumentFragmentScannerImpl.Dispatcher
createContentDispatcher()

Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.createContentDispatcher.

Creates a content dispatcher.
public void
endEntity(String
The name of the entity.
name, Augmentations
Additional information that may include infoset augmentations
augs)

Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.endEntity.

Implements org.apache.xerces.impl.XMLEntityHandler.endEntity.

This method notifies the end of an entity.
public Boolean
getFeatureDefault(String
The feature identifier.
featureId)

Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.getFeatureDefault.

Implements org.apache.xerces.xni.parser.XMLComponent.getFeatureDefault.

Returns the default state for a feature, or null if this component does not want to report a default value for this feature.
public Object
getPropertyDefault(String
The property identifier.
propertyId)

Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.getPropertyDefault.

Implements org.apache.xerces.xni.parser.XMLComponent.getPropertyDefault.

Returns the default state for a property, or null if this component does not want to report a default value for this property.
public String[]
getRecognizedFeatures()

Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.getRecognizedFeatures.

Implements org.apache.xerces.xni.parser.XMLComponent.getRecognizedFeatures.

Returns a list of feature identifiers that are recognized by this component.
public String[]
getRecognizedProperties()

Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.getRecognizedProperties.

Implements org.apache.xerces.xni.parser.XMLComponent.getRecognizedProperties.

Returns a list of property identifiers that are recognized by this component.
protected String
getScannerStateName(int state)

Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.getScannerStateName.

Returns the scanner state name.
public void
reset(XMLComponentManager
The component manager.
componentManager)

Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.reset.

Implements org.apache.xerces.xni.parser.XMLComponent.reset.

Resets the component.
protected boolean
scanDoctypeDecl()

Scans a doctype declaration.

public void
setFeature(String
The feature identifier.
featureId, boolean
The state of the feature.
state)

Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.setFeature.

Implements org.apache.xerces.xni.parser.XMLComponent.setFeature.

Sets the state of a feature.
public void
setInputSource(XMLInputSource
The input source.
inputSource)

Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.setInputSource.

Implements org.apache.xerces.xni.parser.XMLDocumentScanner.setInputSource.

Sets the input source.
public void
setProperty(String
The property identifier.
propertyId, Object
The value of the property.
value)

Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.setProperty.

Implements org.apache.xerces.xni.parser.XMLComponent.setProperty.

Sets the value of a property.
public void
startEntity(String
The name of the entity.
name, XMLResourceIdentifier
The resource identifier.
identifier, String
The auto-detected IANA encoding name of the entity stream. This value will be null in those situations where the entity encoding is not auto-detected (e.g. internal entities or a document entity that is parsed from a java.io.Reader).
encoding, Augmentations
Additional information that may include infoset augmentations
augs)

Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.startEntity.

Implements org.apache.xerces.impl.XMLEntityHandler.startEntity.

This method notifies of the start of an entity.
Inherited from org.apache.xerces.impl.XMLDocumentFragmentScannerImpl:
getDispatcherNamegetDocumentHandlerhandleEndElementscanAttributescanCDATASectionscanCharReferencescanCommentscanContentscanDocumentscanEndElementscanEntityReferencescanPIDatascanStartElementscanStartElementAfterNamescanStartElementNamescanXMLDeclOrTextDeclsetDispatchersetDocumentHandlersetScannerState

Field Detail

DISALLOW_DOCTYPE_DECL_FEATUREback to summary
protected static final String DISALLOW_DOCTYPE_DECL_FEATURE

Feature identifier: load external DTD.

DTD_SCANNERback to summary
protected static final String DTD_SCANNER

Property identifier: DTD scanner.

fDisallowDoctypeback to summary
protected boolean fDisallowDoctype

Disallow doctype declaration.

fDoctypeNameback to summary
protected String fDoctypeName

Doctype name.

fDoctypePublicIdback to summary
protected String fDoctypePublicId

Doctype declaration public identifier.

fDoctypeSystemIdback to summary
protected String fDoctypeSystemId

Doctype declaration system identifier.

fDTDDescriptionback to summary
private final XMLDTDDescription fDTDDescription

A DTD Description.

fDTDDispatcherback to summary
protected final XMLDocumentFragmentScannerImpl.Dispatcher fDTDDispatcher

DTD dispatcher.

fDTDScannerback to summary
protected XMLDTDScanner fDTDScanner

DTD scanner.

FEATURE_DEFAULTSback to summary
private static final Boolean[] FEATURE_DEFAULTS

Hides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.FEATURE_DEFAULTS.

Feature defaults.

fExternalSubsetSourceback to summary
private XMLInputSource fExternalSubsetSource

External subset source.

fLoadExternalDTDback to summary
protected boolean fLoadExternalDTD

Load external DTD.

fNamespaceContextback to summary
protected NamespaceContext fNamespaceContext

Namespace support.

fPrologDispatcherback to summary
protected final XMLDocumentFragmentScannerImpl.Dispatcher fPrologDispatcher

Prolog dispatcher.

fScanningDTDback to summary
protected boolean fScanningDTD

Scanning DTD.

fSeenDoctypeDeclback to summary
protected boolean fSeenDoctypeDecl

Seen doctype declaration.

fStringback to summary
private final XMLString fString

Hides org.apache.xerces.impl.XMLScanner.fString.

String.

fStringBufferback to summary
private final XMLStringBuffer fStringBuffer

Hides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.fStringBuffer.

String buffer.

fStringsback to summary
private final String[] fStrings

Hides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.fStrings.

Array of 3 strings.

fTrailingMiscDispatcherback to summary
protected final XMLDocumentFragmentScannerImpl.Dispatcher fTrailingMiscDispatcher

Trailing miscellaneous section dispatcher.

fValidationManagerback to summary
protected ValidationManager fValidationManager

Validation manager .

fXMLDeclDispatcherback to summary
protected final XMLDocumentFragmentScannerImpl.Dispatcher fXMLDeclDispatcher

XML declaration dispatcher.

LOAD_EXTERNAL_DTDback to summary
protected static final String LOAD_EXTERNAL_DTD

Feature identifier: load external DTD.

NAMESPACE_CONTEXTback to summary
protected static final String NAMESPACE_CONTEXT

property identifier: NamespaceContext

PROPERTY_DEFAULTSback to summary
private static final Object[] PROPERTY_DEFAULTS

Hides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.PROPERTY_DEFAULTS.

Property defaults.

RECOGNIZED_FEATURESback to summary
private static final String[] RECOGNIZED_FEATURES

Hides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.RECOGNIZED_FEATURES.

Recognized features.

RECOGNIZED_PROPERTIESback to summary
private static final String[] RECOGNIZED_PROPERTIES

Hides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.RECOGNIZED_PROPERTIES.

Recognized properties.

SCANNER_STATE_DTD_EXTERNALback to summary
protected static final int SCANNER_STATE_DTD_EXTERNAL

Scanner state: open DTD external subset.

SCANNER_STATE_DTD_EXTERNAL_DECLSback to summary
protected static final int SCANNER_STATE_DTD_EXTERNAL_DECLS

Scanner state: DTD external declarations.

SCANNER_STATE_DTD_INTERNAL_DECLSback to summary
protected static final int SCANNER_STATE_DTD_INTERNAL_DECLS

Scanner state: DTD internal declarations.

SCANNER_STATE_PROLOGback to summary
protected static final int SCANNER_STATE_PROLOG

Scanner state: prolog.

SCANNER_STATE_TRAILING_MISCback to summary
protected static final int SCANNER_STATE_TRAILING_MISC

Scanner state: trailing misc.

SCANNER_STATE_XML_DECLback to summary
protected static final int SCANNER_STATE_XML_DECL

Scanner state: XML declaration.

VALIDATION_MANAGERback to summary
protected static final String VALIDATION_MANAGER

property identifier: ValidationManager

Constructor Detail

XMLDocumentScannerImplback to summary
public XMLDocumentScannerImpl()

Default constructor.

Method Detail

createContentDispatcherback to summary
protected XMLDocumentFragmentScannerImpl.Dispatcher createContentDispatcher()

Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.createContentDispatcher.

Creates a content dispatcher.

endEntityback to summary
public void endEntity(String name, Augmentations augs) throws XNIException

Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.endEntity.

Implements org.apache.xerces.impl.XMLEntityHandler.endEntity.

This method notifies the end of an entity. The DTD has the pseudo-name of "[dtd]" parameter entity names start with '%'; and general entities are just specified by their name.

Parameters
name:String

The name of the entity.

augs:Augmentations

Doc from org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.endEntity.

Additional information that may include infoset augmentations

Exceptions
XNIException:
Thrown by handler to signal an error.
getFeatureDefaultback to summary
public Boolean getFeatureDefault(String featureId)

Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.getFeatureDefault.

Implements org.apache.xerces.xni.parser.XMLComponent.getFeatureDefault.

Returns the default state for a feature, or null if this component does not want to report a default value for this feature.

Parameters
featureId:String

The feature identifier.

Since
Xerces 2.2.0
getPropertyDefaultback to summary
public Object getPropertyDefault(String propertyId)

Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.getPropertyDefault.

Implements org.apache.xerces.xni.parser.XMLComponent.getPropertyDefault.

Returns the default state for a property, or null if this component does not want to report a default value for this property.

Parameters
propertyId:String

The property identifier.

Since
Xerces 2.2.0
getRecognizedFeaturesback to summary
public String[] getRecognizedFeatures()

Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.getRecognizedFeatures.

Implements org.apache.xerces.xni.parser.XMLComponent.getRecognizedFeatures.

Returns a list of feature identifiers that are recognized by this component. This method may return null if no features are recognized by this component.

getRecognizedPropertiesback to summary
public String[] getRecognizedProperties()

Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.getRecognizedProperties.

Implements org.apache.xerces.xni.parser.XMLComponent.getRecognizedProperties.

Returns a list of property identifiers that are recognized by this component. This method may return null if no properties are recognized by this component.

getScannerStateNameback to summary
protected String getScannerStateName(int state)

Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.getScannerStateName.

Returns the scanner state name.

resetback to summary
public void reset(XMLComponentManager componentManager) throws XMLConfigurationException

Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.reset.

Implements org.apache.xerces.xni.parser.XMLComponent.reset.

Resets the component. The component can query the component manager about any features and properties that affect the operation of the component.

Parameters
componentManager:XMLComponentManager

The component manager.

Exceptions
SAXException:
Thrown by component on initialization error. For example, if a feature or property is required for the operation of the component, the component manager may throw a SAXNotRecognizedException or a SAXNotSupportedException.
scanDoctypeDeclback to summary
protected boolean scanDoctypeDecl() throws IOException, XNIException

Scans a doctype declaration.

setFeatureback to summary
public void setFeature(String featureId, boolean state) throws XMLConfigurationException

Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.setFeature.

Implements org.apache.xerces.xni.parser.XMLComponent.setFeature.

Sets the state of a feature. This method is called by the component manager any time after reset when a feature changes state.

Note

Components should silently ignore features that do not affect the operation of the component.

Parameters
featureId:String

The feature identifier.

state:boolean

The state of the feature.

Exceptions
XMLConfigurationException:

Doc from org.apache.xerces.xni.parser.XMLComponent.setFeature.

Thrown for configuration error. In general, components should only throw this exception if it is really a critical error.

SAXNotRecognizedException:
The component should not throw this exception.
SAXNotSupportedException:
The component should not throw this exception.
setInputSourceback to summary
public void setInputSource(XMLInputSource inputSource) throws IOException

Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.setInputSource.

Implements org.apache.xerces.xni.parser.XMLDocumentScanner.setInputSource.

Sets the input source.

Parameters
inputSource:XMLInputSource

The input source.

Exceptions
IOException:
Thrown on i/o error.
setPropertyback to summary
public void setProperty(String propertyId, Object value) throws XMLConfigurationException

Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.setProperty.

Implements org.apache.xerces.xni.parser.XMLComponent.setProperty.

Sets the value of a property. This method is called by the component manager any time after reset when a property changes value.

Note

Components should silently ignore properties that do not affect the operation of the component.

Parameters
propertyId:String

The property identifier.

value:Object

The value of the property.

Exceptions
XMLConfigurationException:

Doc from org.apache.xerces.xni.parser.XMLComponent.setProperty.

Thrown for configuration error. In general, components should only throw this exception if it is really a critical error.

SAXNotRecognizedException:
The component should not throw this exception.
SAXNotSupportedException:
The component should not throw this exception.
startEntityback to summary
public void startEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augs) throws XNIException

Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.startEntity.

Implements org.apache.xerces.impl.XMLEntityHandler.startEntity.

This method notifies of the start of an entity. The DTD has the pseudo-name of "[dtd]" parameter entity names start with '%'; and general entities are just specified by their name.

Parameters
name:String

The name of the entity.

identifier:XMLResourceIdentifier

The resource identifier.

encoding:String

The auto-detected IANA encoding name of the entity stream. This value will be null in those situations where the entity encoding is not auto-detected (e.g. internal entities or a document entity that is parsed from a java.io.Reader).

augs:Augmentations

Doc from org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.startEntity.

Additional information that may include infoset augmentations

Exceptions
XNIException:
Thrown by handler to signal an error.
org.apache.xerces.impl back to summary

protected Class XMLDocumentScannerImpl.ContentDispatcher

extends FragmentContentDispatcher
Class Inheritance
Known Direct Subclasses
org.apache.xerces.impl.XMLNSDocumentScannerImpl.NSContentDispatcher, org.apache.xerces.impl.XML11NSDocumentScannerImpl.NS11ContentDispatcher
Dispatcher to handle content scanning.
Authors
Andy Clark, IBM, Eric Ye, IBM

Constructor Summary

AccessConstructor and Description
protected
ContentDispatcher()

Method Summary

Modifier and TypeMethod and Description
protected boolean

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.
elementDepthIsZeroHook()

Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.FragmentContentDispatcher.elementDepthIsZeroHook.

Element depth iz zero.
protected void
endOfFileHook(EOFException e)

Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.FragmentContentDispatcher.endOfFileHook.

End of file hook.
protected void
resolveExternalSubsetAndRead()

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

protected boolean

Returns:

True if the "DOCTYPE" was scanned; false if "DOCTYPE" was not scanned.
scanForDoctypeHook()

Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.FragmentContentDispatcher.scanForDoctypeHook.

Scan for DOCTYPE hook.
protected boolean

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.
scanRootElementHook()

Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.FragmentContentDispatcher.scanRootElementHook.

Scan for root element hook.
Inherited from org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.FragmentContentDispatcher:
dispatch

Constructor Detail

ContentDispatcherback to summary
protected ContentDispatcher()

Method Detail

elementDepthIsZeroHookback to summary
protected boolean elementDepthIsZeroHook() throws IOException, XNIException

Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.FragmentContentDispatcher.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:boolean

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.

endOfFileHookback to summary
protected void endOfFileHook(EOFException e) throws IOException, XNIException

Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.FragmentContentDispatcher.endOfFileHook.

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.

resolveExternalSubsetAndReadback to summary
protected void resolveExternalSubsetAndRead() throws IOException, XNIException

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.

scanForDoctypeHookback to summary
protected boolean scanForDoctypeHook() throws IOException, XNIException

Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.FragmentContentDispatcher.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:boolean

True if the "DOCTYPE" was scanned; false if "DOCTYPE" was not scanned.

scanRootElementHookback to summary
protected boolean scanRootElementHook() throws IOException, XNIException

Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.FragmentContentDispatcher.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:boolean

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.

org.apache.xerces.impl back to summary

protected final Class XMLDocumentScannerImpl.DTDDispatcher

extends Object
implements Dispatcher
Class Inheritance
All Implemented Interfaces
org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.Dispatcher
Dispatcher to handle the internal and external DTD subsets.
Author
Andy Clark, IBM

Constructor Summary

AccessConstructor and Description
protected
DTDDispatcher()

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

True if there is more to dispatch either from this or a another dispatcher.
dispatch(boolean
True if this dispatcher is intended to scan and dispatch as much as possible.
complete)

Implements org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.Dispatcher.dispatch.

Dispatch an XML "event".
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

DTDDispatcherback to summary
protected DTDDispatcher()

Method Detail

dispatchback to summary
public boolean dispatch(boolean complete) throws IOException, XNIException

Implements org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.Dispatcher.dispatch.

Dispatch an XML "event".

Parameters
complete:boolean

True if this dispatcher is intended to scan and dispatch as much as possible.

Returns:boolean

True if there is more to dispatch either from this or a another dispatcher.

Exceptions
IOException:
Thrown on i/o error.
XNIException:
Thrown on parse error.
org.apache.xerces.impl back to summary

protected final Class XMLDocumentScannerImpl.PrologDispatcher

extends Object
implements Dispatcher
Class Inheritance
  • java.lang.Object
  • org.apache.xerces.impl.XMLDocumentScannerImpl.PrologDispatcher
All Implemented Interfaces
org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.Dispatcher
Dispatcher to handle prolog scanning.
Author
Andy Clark, IBM

Constructor Summary

AccessConstructor and Description
protected
PrologDispatcher()

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

True if there is more to dispatch either from this or a another dispatcher.
dispatch(boolean
True if this dispatcher is intended to scan and dispatch as much as possible.
complete)

Implements org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.Dispatcher.dispatch.

Dispatch an XML "event".
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

PrologDispatcherback to summary
protected PrologDispatcher()

Method Detail

dispatchback to summary
public boolean dispatch(boolean complete) throws IOException, XNIException

Implements org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.Dispatcher.dispatch.

Dispatch an XML "event".

Parameters
complete:boolean

True if this dispatcher is intended to scan and dispatch as much as possible.

Returns:boolean

True if there is more to dispatch either from this or a another dispatcher.

Exceptions
IOException:
Thrown on i/o error.
XNIException:
Thrown on parse error.
org.apache.xerces.impl back to summary

protected final Class XMLDocumentScannerImpl.TrailingMiscDispatcher

extends Object
implements Dispatcher
Class Inheritance
  • java.lang.Object
  • org.apache.xerces.impl.XMLDocumentScannerImpl.TrailingMiscDispatcher
All Implemented Interfaces
org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.Dispatcher
Dispatcher to handle trailing miscellaneous section scanning.
Authors
Andy Clark, IBM, Eric Ye, IBM

Constructor Summary

AccessConstructor and Description
protected
TrailingMiscDispatcher()

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

True if there is more to dispatch either from this or a another dispatcher.
dispatch(boolean
True if this dispatcher is intended to scan and dispatch as much as possible.
complete)

Implements org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.Dispatcher.dispatch.

Dispatch an XML "event".
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

TrailingMiscDispatcherback to summary
protected TrailingMiscDispatcher()

Method Detail

dispatchback to summary
public boolean dispatch(boolean complete) throws IOException, XNIException

Implements org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.Dispatcher.dispatch.

Dispatch an XML "event".

Parameters
complete:boolean

True if this dispatcher is intended to scan and dispatch as much as possible.

Returns:boolean

True if there is more to dispatch either from this or a another dispatcher.

Exceptions
IOException:
Thrown on i/o error.
XNIException:
Thrown on parse error.
org.apache.xerces.impl back to summary

protected final Class XMLDocumentScannerImpl.XMLDeclDispatcher

extends Object
implements Dispatcher
Class Inheritance
  • java.lang.Object
  • org.apache.xerces.impl.XMLDocumentScannerImpl.XMLDeclDispatcher
All Implemented Interfaces
org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.Dispatcher
Dispatcher to handle XMLDecl scanning.
Author
Andy Clark, IBM

Constructor Summary

AccessConstructor and Description
protected
XMLDeclDispatcher()

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

True if there is more to dispatch either from this or a another dispatcher.
dispatch(boolean
True if this dispatcher is intended to scan and dispatch as much as possible.
complete)

Implements org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.Dispatcher.dispatch.

Dispatch an XML "event".
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

XMLDeclDispatcherback to summary
protected XMLDeclDispatcher()

Method Detail

dispatchback to summary
public boolean dispatch(boolean complete) throws IOException, XNIException

Implements org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.Dispatcher.dispatch.

Dispatch an XML "event".

Parameters
complete:boolean

True if this dispatcher is intended to scan and dispatch as much as possible.

Returns:boolean

True if there is more to dispatch either from this or a another dispatcher.

Exceptions
IOException:
Thrown on i/o error.
XNIException:
Thrown on parse error.