XMLDocumentFragmentScannerImpl (openjdk7-jaxp-external 7.60.33 API)

java.lang.Object
- jdk7u.jaxp.org.apache.xerces.external.impl.XMLScanner
- - jdk7u.jaxp.org.apache.xerces.external.impl.XMLDocumentFragmentScannerImpl

All Implemented Interfaces:

XMLEntityHandler, XMLComponent, XMLDocumentScanner, XMLDocumentSource, XMLBufferListener

Direct Known Subclasses:

XMLDocumentScannerImpl
```
public class XMLDocumentFragmentScannerImpl
extends XMLScanner
implements XMLDocumentScanner, XMLComponent, XMLEntityHandler, XMLBufferListener
```
This class is responsible for scanning the structure and content of document fragments. This class has been modified as per the new design which is more suited to efficiently build pull parser. Lot of improvements have been done and the code has been added to support stax functionality/features.

Version:

$Id: XMLDocumentFragmentScannerImpl.java,v 1.19 2010-11-02 19:54:55 joehw Exp $

Author:

Neeraj Bajaj SUN Microsystems, K.Venugopal SUN Microsystems, Glenn Marcy, IBM, Andy Clark, IBM, Arnaud Le Hors, IBM, Eric Ye, IBM, Sunitha Reddy, SUN Microsystems

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static interface`	`XMLDocumentFragmentScannerImpl.Driver` Drives the parser to the next state/event on the input.
`protected static class`	`XMLDocumentFragmentScannerImpl.Element`
`protected class`	`XMLDocumentFragmentScannerImpl.ElementStack` Element stack.
`protected class`	`XMLDocumentFragmentScannerImpl.ElementStack2` Element stack.
`protected class`	`XMLDocumentFragmentScannerImpl.FragmentContentDriver` Driver to handle content scanning.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static boolean`	`DEBUG` Debug driver next
`protected static boolean`	`DEBUG_COALESCE`
`protected static boolean`	`DEBUG_NEXT` Debug driver next
`protected static boolean`	`DEBUG_START_END_ELEMENT` Debug content driver scanning.
`protected DTDGrammarUtil`	`dtdGrammarUtil`
`protected static String`	`ENTITY_RESOLVER` Property identifier: entity resolver.
`protected String`	`fAccessExternalDTD` comma-delimited list of protocols that are allowed for the purpose of accessing external dtd or entity references
`protected boolean`	`fAdd`
`protected boolean`	`fAddDefaultAttr`
`protected QName`	`fAttributeQName` Attribute QName.
`protected XMLAttributesIteratorImpl`	`fAttributes` CHANGED: Using XMLAttributesIteratorImpl instead of XMLAttributesImpl.
`protected XMLStringBuffer`	`fContentBuffer` Making the buffer accesible to derived class -- stores PI data
`protected XMLDocumentFragmentScannerImpl.Driver`	`fContentDriver` Content driver.
`protected QName`	`fCurrentElement` Current element.
`protected String`	`fDeclaredEncoding`
`protected boolean`	`fDisallowDoctype` Xerces Feature: Disallow doctype declaration.
`protected XMLDocumentHandler`	`fDocumentHandler` Document handler.
`protected XMLDocumentFragmentScannerImpl.Driver`	`fDriver` Active driver.
`protected int`	`fElementAttributeLimit`
`protected QName`	`fElementQName` Element QName.
`protected String`	`fElementRawname`
`protected XMLDocumentFragmentScannerImpl.ElementStack`	`fElementStack` Element stack.
`protected XMLDocumentFragmentScannerImpl.ElementStack2`	`fElementStack2`
`protected boolean`	`fEmptyElement`
`protected int[]`	`fEntityStack` Entity stack.
`protected XMLEntityStorage`	`fEntityStore` Entity Storage
`protected ExternalSubsetResolver`	`fExternalSubsetResolver` External subset resolver.
`protected boolean`	`fHasExternalDTD` has external dtd
`protected boolean`	`fInScanContent` SubScanner state: inside scanContent method.
`protected boolean`	`fIsCoalesce`
`protected boolean`	`fLastSectionWasCData`
`protected boolean`	`fLastSectionWasCharacterData`
`protected boolean`	`fLastSectionWasEntityReference`
`protected int`	`fMarkupDepth` Markup depth.
`protected boolean`	`fNotifyBuiltInRefs` Notify built-in references.
`protected boolean`	`foundBuiltInRefs`
`protected XMLString`	`fPIData`
`protected String`	`fPITarget` Document system identifier.
`protected boolean`	`fReadingAttributes`
`protected boolean`	`fReplaceEntityReferences`
`protected boolean`	`fReportCdataEvent`
`protected int`	`fScannerLastState`
`protected int`	`fScannerState` Scanner state.
`protected boolean`	`fScanToEnd`
`protected boolean`	`fShouldSkip`
`protected boolean`	`fSkip`
`protected boolean`	`fStandalone`
`protected boolean`	`fStandaloneSet` Standalone.
`protected boolean`	`fStrictURI` standard uri conformant (strict uri).
`protected XMLStringBuffer`	`fStringBuffer` Making the buffer accesible to derived class -- String buffer.
`protected XMLStringBuffer`	`fStringBuffer2` Making the buffer accesible to derived class -- String buffer.
`protected boolean`	`fSupportDTD`
`protected boolean`	`fSupportExternalEntities`
`protected XMLString`	`fTempString` String.
`protected XMLString`	`fTempString2` String.
`protected boolean`	`fUsebuffer`
`protected String`	`fVersion`
`protected static String`	`NOTIFY_BUILTIN_REFS` Feature identifier: notify built-in refereces.
`protected static int`	`SCANNER_STATE_ATTRIBUTE`
`protected static int`	`SCANNER_STATE_ATTRIBUTE_VALUE`
`protected static int`	`SCANNER_STATE_BUILT_IN_REFS`
`protected static int`	`SCANNER_STATE_CDATA` Scanner state: CDATA section.
`protected static int`	`SCANNER_STATE_CHAR_REFERENCE`
`protected static int`	`SCANNER_STATE_CHARACTER_DATA` Scanner state: Text declaration.
`protected static int`	`SCANNER_STATE_COMMENT` Scanner state: comment.
`protected static int`	`SCANNER_STATE_CONTENT` Scanner state: content.
`protected static int`	`SCANNER_STATE_DOCTYPE` Scanner state: DOCTYPE.
`protected static int`	`SCANNER_STATE_END_ELEMENT_TAG`
`protected static int`	`SCANNER_STATE_END_OF_INPUT` Scanner state: end of input.
`protected static int`	`SCANNER_STATE_PI` Scanner state: processing instruction.
`protected static int`	`SCANNER_STATE_REFERENCE` Scanner state: reference.
`protected static int`	`SCANNER_STATE_ROOT_ELEMENT` Scanner state: root element.
`protected static int`	`SCANNER_STATE_START_ELEMENT_TAG`
`protected static int`	`SCANNER_STATE_START_OF_MARKUP` Scanner state: start of markup.
`protected static int`	`SCANNER_STATE_TERMINATED` Scanner state: terminated.
`protected static int`	`SCANNER_STATE_TEXT_DECL` Scanner state: Text declaration.
`protected static int`	`SCANNER_STATE_XML_DECL` Scanner state: XML Declaration
`protected static String`	`STANDARD_URI_CONFORMANT` Feature identifier: standard uri conformant

Fields inherited from class jdk7u.jaxp.org.apache.xerces.external.impl.XMLScanner
attributeValueCache, DEBUG_ATTR_NORMALIZATION, ENTITY_MANAGER, ERROR_REPORTER, fAmpSymbol, fAposSymbol, fAttributeCacheInitDone, fAttributeCacheUsedCount, fCharRefLiteral, fEncodingSymbol, fEntityDepth, fEntityManager, fEntityScanner, fErrorReporter, fEvent, fGtSymbol, fLimitAnalyzer, fLtSymbol, fNamespaces, fNotifyCharRefs, fParserSettings, fPropertyManager, fQuotSymbol, fReportEntity, fResourceIdentifier, fScanningAttribute, fSecurityManager, fStandaloneSymbol, fStringBufferIndex, fSymbolTable, fValidation, fVersionSymbol, NAMESPACES, NOTIFY_CHAR_REFS, PARSER_SETTINGS, stringBufferCache, SYMBOL_TABLE, VALIDATION

Constructor Summary

Constructors
Constructor and Description

XMLDocumentFragmentScannerImpl()
Default constructor.

Constructors
Constructor and Description
`XMLDocumentFragmentScannerImpl()` Default constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`protected XMLDocumentFragmentScannerImpl.Driver`	`createContentDriver()` Creates a content Driver.
`void`	`endEntity(String name, Augmentations augs)` This method notifies the end of an entity.
`XMLAttributesIteratorImpl`	`getAttributeIterator()` return the attribute iterator implementation
`XMLString`	`getCharacterData()`
`String`	`getComment()`
`XMLDocumentHandler`	`getDocumentHandler()` Returns the document handler
`String`	`getDriverName(XMLDocumentFragmentScannerImpl.Driver driver)` Returns the driver name.
`QName`	`getElementQName()`
`String`	`getEntityName()`
`Boolean`	`getFeatureDefault(String featureId)` Returns the default state for a feature, or null if this component does not want to report a default value for this feature.
`XMLStringBuffer`	`getPIData()`
`String`	`getPITarget()`
`Object`	`getPropertyDefault(String propertyId)` Returns the default state for a property, or null if this component does not want to report a default value for this property.
`String[]`	`getRecognizedFeatures()` Returns a list of feature identifiers that are recognized by this component.
`String[]`	`getRecognizedProperties()` Returns a list of property identifiers that are recognized by this component.
`protected String`	`getScannerStateName(int state)` Returns the scanner state name.
`protected XMLString`	`getString()` this function gets an XMLString (which is used to store the attribute value) from the special pool maintained for attributes.
`boolean`	`hasAttributes()`
`boolean`	`isStandAlone()` return if the doucment is standalone
`int`	`next()` return the next state on the input
`void`	`refresh()` Implements XMLBufferListener interface.
`void`	`refresh(int refreshPosition)` receives callbacks from `XMLEntityReader` when buffer is being changed.
`void`	`reset(PropertyManager propertyManager)`
`void`	`reset(XMLComponentManager componentManager)` Resets the component.
`protected void`	`scanAttribute(XMLAttributes attributes)` Scans an attribute name value pair.
`protected boolean`	`scanCDATASection(XMLStringBuffer contentBuffer, boolean complete)` Scans a CDATA section.
`protected void`	`scanCharReference()` Scans a character reference.
`protected void`	`scanComment()` Scans a comment.
`protected int`	`scanContent(XMLStringBuffer content)` Scans element content.
`boolean`	`scanDocument(boolean complete)` Scans a document.
`protected int`	`scanEndElement()` Scans an end element.
`protected void`	`scanEntityReference(XMLStringBuffer content)` Scans an entity reference.
`protected void`	`scanPIData(String target, XMLStringBuffer data)` Scans a processing data.
`protected boolean`	`scanStartElement()` Scans a start element.
`protected void`	`scanXMLDeclOrTextDecl(boolean scanningTextDecl)` Scans an XML or text declaration.
`protected boolean`	`seekCloseOfStartTag()` Looks for the close of start tag, i.e. if it finds '>' or '/>' Characters are consumed.
`void`	`setDocumentHandler(XMLDocumentHandler documentHandler)` setDocumentHandler
`protected void`	`setDriver(XMLDocumentFragmentScannerImpl.Driver driver)` Sets the Driver.
`void`	`setFeature(String featureId, boolean state)` Sets the state of a feature.
`void`	`setInputSource(XMLInputSource inputSource)` Sets the input source.
`void`	`setProperty(String propertyId, Object value)` Sets the value of a property.
`protected void`	`setScannerState(int state)` Sets the scanner state.
`protected boolean`	`skipElement()`
`boolean`	`standaloneSet()` return if standalone is set
`void`	`startEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augs)` This method notifies of the start of an entity.

Methods inherited from class jdk7u.jaxp.org.apache.xerces.external.impl.XMLScanner
getFeature, isInvalid, isInvalidLiteral, isValidNameChar, isValidNameStartChar, isValidNCName, normalizeWhitespace, reportFatalError, reset, scanAttributeValue, scanCharReferenceValue, scanComment, scanExternalID, scanPI, scanPseudoAttribute, scanPubidLiteral, scanSurrogates, scanXMLDeclOrTextDecl, setPropertyManager, versionSupported

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - fElementAttributeLimit
```
protected int fElementAttributeLimit
```
  - fExternalSubsetResolver
```
protected ExternalSubsetResolver fExternalSubsetResolver
```
    External subset resolver.
  - SCANNER_STATE_START_OF_MARKUP
```
protected static final int SCANNER_STATE_START_OF_MARKUP
```
    Scanner state: start of markup.
    
    See Also:
    Constant Field Values
  - SCANNER_STATE_CONTENT
```
protected static final int SCANNER_STATE_CONTENT
```
    Scanner state: content.
    
    See Also:
    Constant Field Values
  - SCANNER_STATE_PI
```
protected static final int SCANNER_STATE_PI
```
    Scanner state: processing instruction.
    
    See Also:
    Constant Field Values
  - SCANNER_STATE_DOCTYPE
```
protected static final int SCANNER_STATE_DOCTYPE
```
    Scanner state: DOCTYPE.
    
    See Also:
    Constant Field Values
  - SCANNER_STATE_XML_DECL
```
protected static final int SCANNER_STATE_XML_DECL
```
    Scanner state: XML Declaration
    
    See Also:
    Constant Field Values
  - SCANNER_STATE_ROOT_ELEMENT
```
protected static final int SCANNER_STATE_ROOT_ELEMENT
```
    Scanner state: root element.
    
    See Also:
    Constant Field Values
  - SCANNER_STATE_COMMENT
```
protected static final int SCANNER_STATE_COMMENT
```
    Scanner state: comment.
    
    See Also:
    Constant Field Values
  - SCANNER_STATE_REFERENCE
```
protected static final int SCANNER_STATE_REFERENCE
```
    Scanner state: reference.
    
    See Also:
    Constant Field Values
  - SCANNER_STATE_ATTRIBUTE
```
protected static final int SCANNER_STATE_ATTRIBUTE
```
    See Also:
    Constant Field Values
  - SCANNER_STATE_ATTRIBUTE_VALUE
```
protected static final int SCANNER_STATE_ATTRIBUTE_VALUE
```
    See Also:
    Constant Field Values
  - SCANNER_STATE_END_OF_INPUT
```
protected static final int SCANNER_STATE_END_OF_INPUT
```
    Scanner state: end of input.
    
    See Also:
    Constant Field Values
  - SCANNER_STATE_TERMINATED
```
protected static final int SCANNER_STATE_TERMINATED
```
    Scanner state: terminated.
    
    See Also:
    Constant Field Values
  - SCANNER_STATE_CDATA
```
protected static final int SCANNER_STATE_CDATA
```
    Scanner state: CDATA section.
    
    See Also:
    Constant Field Values
  - SCANNER_STATE_TEXT_DECL
```
protected static final int SCANNER_STATE_TEXT_DECL
```
    Scanner state: Text declaration.
    
    See Also:
    Constant Field Values
  - SCANNER_STATE_CHARACTER_DATA
```
protected static final int SCANNER_STATE_CHARACTER_DATA
```
    Scanner state: Text declaration.
    
    See Also:
    Constant Field Values
  - SCANNER_STATE_START_ELEMENT_TAG
```
protected static final int SCANNER_STATE_START_ELEMENT_TAG
```
    See Also:
    Constant Field Values
  - SCANNER_STATE_END_ELEMENT_TAG
```
protected static final int SCANNER_STATE_END_ELEMENT_TAG
```
    See Also:
    Constant Field Values
  - SCANNER_STATE_CHAR_REFERENCE
```
protected static final int SCANNER_STATE_CHAR_REFERENCE
```
    See Also:
    Constant Field Values
  - SCANNER_STATE_BUILT_IN_REFS
```
protected static final int SCANNER_STATE_BUILT_IN_REFS
```
    See Also:
    Constant Field Values
  - NOTIFY_BUILTIN_REFS
```
protected static final String NOTIFY_BUILTIN_REFS
```
    Feature identifier: notify built-in refereces.
    
    See Also:
    Constant Field Values
  - ENTITY_RESOLVER
```
protected static final String ENTITY_RESOLVER
```
    Property identifier: entity resolver.
    
    See Also:
    Constant Field Values
  - STANDARD_URI_CONFORMANT
```
protected static final String STANDARD_URI_CONFORMANT
```
    Feature identifier: standard uri conformant
    
    See Also:
    Constant Field Values
  - DEBUG_START_END_ELEMENT
```
protected static final boolean DEBUG_START_END_ELEMENT
```
    Debug content driver scanning.
    
    See Also:
    Constant Field Values
  - DEBUG_NEXT
```
protected static final boolean DEBUG_NEXT
```
    Debug driver next
    
    See Also:
    Constant Field Values
  - DEBUG
```
protected static final boolean DEBUG
```
    Debug driver next
    
    See Also:
    Constant Field Values
  - DEBUG_COALESCE
```
protected static final boolean DEBUG_COALESCE
```
    See Also:
    Constant Field Values
  - fDocumentHandler
```
protected XMLDocumentHandler fDocumentHandler
```
    Document handler.
  - fScannerLastState
```
protected int fScannerLastState
```
  - fEntityStore
```
protected XMLEntityStorage fEntityStore
```
    Entity Storage
  - fEntityStack
```
protected int[] fEntityStack
```
    Entity stack.
  - fMarkupDepth
```
protected int fMarkupDepth
```
    Markup depth.
  - fEmptyElement
```
protected boolean fEmptyElement
```
  - fReadingAttributes
```
protected boolean fReadingAttributes
```
  - fScannerState
```
protected int fScannerState
```
    Scanner state.
  - fInScanContent
```
protected boolean fInScanContent
```
    SubScanner state: inside scanContent method.
  - fLastSectionWasCData
```
protected boolean fLastSectionWasCData
```
  - fLastSectionWasEntityReference
```
protected boolean fLastSectionWasEntityReference
```
  - fLastSectionWasCharacterData
```
protected boolean fLastSectionWasCharacterData
```
  - fHasExternalDTD
```
protected boolean fHasExternalDTD
```
    has external dtd
  - fStandaloneSet
```
protected boolean fStandaloneSet
```
    Standalone.
  - fStandalone
```
protected boolean fStandalone
```
  - fVersion
```
protected String fVersion
```
  - fCurrentElement
```
protected QName fCurrentElement
```
    Current element.
  - fElementStack
```
protected XMLDocumentFragmentScannerImpl.ElementStack fElementStack
```
    Element stack.
  - fElementStack2
```
protected XMLDocumentFragmentScannerImpl.ElementStack2 fElementStack2
```
  - fPITarget
```
protected String fPITarget
```
    Document system identifier. REVISIT: So what's this used for? - NG protected String fDocumentSystemId;
  - fPIData
```
protected XMLString fPIData
```
  - fNotifyBuiltInRefs
```
protected boolean fNotifyBuiltInRefs
```
    Notify built-in references.
  - fSupportDTD
```
protected boolean fSupportDTD
```
  - fReplaceEntityReferences
```
protected boolean fReplaceEntityReferences
```
  - fSupportExternalEntities
```
protected boolean fSupportExternalEntities
```
  - fReportCdataEvent
```
protected boolean fReportCdataEvent
```
  - fIsCoalesce
```
protected boolean fIsCoalesce
```
  - fDeclaredEncoding
```
protected String fDeclaredEncoding
```
  - fDisallowDoctype
```
protected boolean fDisallowDoctype
```
    Xerces Feature: Disallow doctype declaration.
  - fAccessExternalDTD
```
protected String fAccessExternalDTD
```
    comma-delimited list of protocols that are allowed for the purpose of accessing external dtd or entity references
  - fStrictURI
```
protected boolean fStrictURI
```
    standard uri conformant (strict uri). http://apache.org/xml/features/standard-uri-conformant
  - fDriver
```
protected XMLDocumentFragmentScannerImpl.Driver fDriver
```
    Active driver.
  - fContentDriver
```
protected XMLDocumentFragmentScannerImpl.Driver fContentDriver
```
    Content driver.
  - fElementQName
```
protected QName fElementQName
```
    Element QName.
  - fAttributeQName
```
protected QName fAttributeQName
```
    Attribute QName.
  - fAttributes
```
protected XMLAttributesIteratorImpl fAttributes
```
    CHANGED: Using XMLAttributesIteratorImpl instead of XMLAttributesImpl. This class implements Iterator interface so we can directly give Attributes in the form of iterator.
  - fTempString
```
protected XMLString fTempString
```
    String.
  - fTempString2
```
protected XMLString fTempString2
```
    String.
  - fStringBuffer
```
protected XMLStringBuffer fStringBuffer
```
    Making the buffer accesible to derived class -- String buffer.
  - fStringBuffer2
```
protected XMLStringBuffer fStringBuffer2
```
    Making the buffer accesible to derived class -- String buffer.
  - fContentBuffer
```
protected XMLStringBuffer fContentBuffer
```
    Making the buffer accesible to derived class -- stores PI data
  - fScanToEnd
```
protected boolean fScanToEnd
```
  - dtdGrammarUtil
```
protected DTDGrammarUtil dtdGrammarUtil
```
  - fAddDefaultAttr
```
protected boolean fAddDefaultAttr
```
  - foundBuiltInRefs
```
protected boolean foundBuiltInRefs
```
  - fElementRawname
```
protected String fElementRawname
```
  - fShouldSkip
```
protected boolean fShouldSkip
```
  - fAdd
```
protected boolean fAdd
```
  - fSkip
```
protected boolean fSkip
```
  - fUsebuffer
```
protected boolean fUsebuffer
```
- Constructor Detail
  - XMLDocumentFragmentScannerImpl
```
public XMLDocumentFragmentScannerImpl()
```
    Default constructor.
- Method Detail
  - setInputSource
```
public void setInputSource(XMLInputSource inputSource)
                    throws IOException
```
    Sets the input source.
    
    Specified by:
    
    setInputSource in interface XMLDocumentScanner
    
    Parameters:
    inputSource - The input source.
    
    Throws:
    
    IOException - Thrown on i/o error.
  - scanDocument
```
public boolean scanDocument(boolean complete)
                     throws IOException,
                            XNIException
```
    Scans a document.
    
    Specified by:
    
    scanDocument in interface XMLDocumentScanner
    
    Parameters:
    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.
    
    Returns:
    True if there is more to scan, false otherwise.
    
    Throws:
    
    IOException
    
    XNIException
  - getElementQName
```
public QName getElementQName()
```
  - next
```
public int next()
         throws IOException,
                XNIException
```
    return the next state on the input
    
    Specified by:
    
    next in interface XMLDocumentScanner
    
    Returns:
    int
    
    Throws:
    
    IOException
    
    XNIException
  - reset
```
public void reset(XMLComponentManager componentManager)
           throws XMLConfigurationException
```
    Resets the component. The component can query the component manager about any features and properties that affect the operation of the component.
    
    Specified by:
    
    reset in interface XMLComponent
    
    Overrides:
    
    reset in class XMLScanner
    
    Parameters:
    componentManager - The component manager.
    
    Throws:
    
    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.
    
    XMLConfigurationException
  - reset
```
public void reset(PropertyManager propertyManager)
```
    Overrides:
    
    reset in class XMLScanner
  - getRecognizedFeatures
```
public String[] 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.
    
    Specified by:
    
    getRecognizedFeatures in interface XMLComponent
  - setFeature
```
public void setFeature(String featureId,
              boolean state)
                throws XMLConfigurationException
```
    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.
    
    Specified by:
    
    setFeature in interface XMLComponent
    
    Overrides:
    
    setFeature in class XMLScanner
    
    Parameters:
    featureId - The feature identifier.
    state - The state of the feature.
    
    Throws:
    
    SAXNotRecognizedException - The component should not throw this exception.
    
    SAXNotSupportedException - The component should not throw this exception.
    
    XMLConfigurationException - Thrown for configuration error. In general, components should only throw this exception if it is really a critical error.
  - getRecognizedProperties
```
public String[] 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.
    
    Specified by:
    
    getRecognizedProperties in interface XMLComponent
  - setProperty
```
public void setProperty(String propertyId,
               Object value)
                 throws XMLConfigurationException
```
    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.
    
    Specified by:
    
    setProperty in interface XMLComponent
    
    Overrides:
    
    setProperty in class XMLScanner
    
    Parameters:
    propertyId - The property identifier.
    value - The value of the property.
    
    Throws:
    
    SAXNotRecognizedException - The component should not throw this exception.
    
    SAXNotSupportedException - The component should not throw this exception.
    
    XMLConfigurationException - Thrown for configuration error. In general, components should only throw this exception if it is really a critical error.
  - getFeatureDefault
```
public Boolean getFeatureDefault(String featureId)
```
    Returns the default state for a feature, or null if this component does not want to report a default value for this feature.
    
    Specified by:
    
    getFeatureDefault in interface XMLComponent
    
    Parameters:
    featureId - The feature identifier.
    Since:
    
    Xerces 2.2.0
  - getPropertyDefault
```
public Object getPropertyDefault(String propertyId)
```
    Returns the default state for a property, or null if this component does not want to report a default value for this property.
    
    Specified by:
    
    getPropertyDefault in interface XMLComponent
    
    Parameters:
    propertyId - The property identifier.
    Since:
    
    Xerces 2.2.0
  - setDocumentHandler
```
public void setDocumentHandler(XMLDocumentHandler documentHandler)
```
    setDocumentHandler
    
    Specified by:
    
    setDocumentHandler in interface XMLDocumentSource
    
    Parameters:
    documentHandler -
  - getDocumentHandler
```
public XMLDocumentHandler getDocumentHandler()
```
    Returns the document handler
    
    Specified by:
    
    getDocumentHandler in interface XMLDocumentSource
  - startEntity
```
public void startEntity(String name,
               XMLResourceIdentifier identifier,
               String encoding,
               Augmentations augs)
                 throws XNIException
```
    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.
    
    Specified by:
    
    startEntity in interface XMLEntityHandler
    
    Overrides:
    
    startEntity in class XMLScanner
    
    Parameters:
    name - The name of the entity.
    identifier - The resource identifier.
    encoding - 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 - Additional information that may include infoset augmentations
    
    Throws:
    
    XNIException - Thrown by handler to signal an error.
  - endEntity
```
public void endEntity(String name,
             Augmentations augs)
               throws IOException,
                      XNIException
```
    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.
    
    Specified by:
    
    endEntity in interface XMLEntityHandler
    
    Overrides:
    
    endEntity in class XMLScanner
    
    Parameters:
    name - The name of the entity.
    augs - Additional information that may include infoset augmentations
    
    Throws:
    
    XNIException - Thrown by handler to signal an error.
    
    IOException - This exception might be thrown when there is premature end of entity
  - createContentDriver
```
protected XMLDocumentFragmentScannerImpl.Driver createContentDriver()
```
    Creates a content Driver.
  - scanXMLDeclOrTextDecl
```
protected void scanXMLDeclOrTextDecl(boolean scanningTextDecl)
                              throws IOException,
                                     XNIException
```
    Scans an XML or text declaration.
```
 [23] XMLDecl ::= '<?xml' VersionInfo EncodingDecl? SDDecl? S? '?>'
 [24] VersionInfo ::= S 'version' Eq (' VersionNum ' | " VersionNum ")
 [80] EncodingDecl ::= S 'encoding' Eq ('"' EncName '"' |  "'" EncName "'" )
 [81] EncName ::= [A-Za-z] ([A-Za-z0-9._] | '-')*
 [32] SDDecl ::= S 'standalone' Eq (("'" ('yes' | 'no') "'")
                 | ('"' ('yes' | 'no') '"'))

 [77] TextDecl ::= '<?xml' VersionInfo? EncodingDecl S? '?>'
 
```
    Parameters:
    scanningTextDecl - True if a text declaration is to be scanned instead of an XML declaration.
    
    Throws:
    
    IOException
    
    XNIException
  - getPITarget
```
public String getPITarget()
```
  - getPIData
```
public XMLStringBuffer getPIData()
```
  - getCharacterData
```
public XMLString getCharacterData()
```
  - scanPIData
```
protected void scanPIData(String target,
              XMLStringBuffer data)
                   throws IOException,
                          XNIException
```
    Scans a processing data. This is needed to handle the situation where a document starts with a processing instruction whose target name starts with "xml". (e.g. xmlfoo)
    
    Overrides:
    
    scanPIData in class XMLScanner
    
    Parameters:
    target - The PI target
    data - The XMLStringBuffer to fill in with the data
    
    Throws:
    
    IOException
    
    XNIException
  - scanComment
```
protected void scanComment()
                    throws IOException,
                           XNIException
```
    Scans a comment.
```
 [15] Comment ::= ''
 
```
    Note: Called after scanning past '<!--'
    Throws:
    
    IOException
    
    XNIException
  - getComment
```
public String getComment()
```
  - skipElement
```
protected boolean skipElement()
                       throws IOException
```
    Throws:
    
    IOException
  - scanStartElement
```
protected boolean scanStartElement()
                            throws IOException,
                                   XNIException
```
    Scans a start element. This method will handle the binding of namespace information and notifying the handler of the start of the element.
```
 [44] EmptyElemTag ::= '<' Name (S Attribute)* S? '/>'
 [40] STag ::= '<' Name (S Attribute)* S? '>'
 
```
    Note: This method assumes that the leading '<' character has been consumed.
    Note: This method uses the fElementQName and fAttributes variables. The contents of these variables will be destroyed. The caller should copy important information out of these variables before calling this method. NB: Content in fAttributes is valid only till the state of the parser is XMLEvent.START_ELEMENT
    Returns:
    True if element is empty. (i.e. It matches production [44].
    
    Throws:
    
    IOException
    
    XNIException
  - seekCloseOfStartTag
```
protected boolean seekCloseOfStartTag()
                               throws IOException,
                                      XNIException
```
    Looks for the close of start tag, i.e. if it finds '>' or '/>' Characters are consumed.
    
    Throws:
    
    IOException
    
    XNIException
  - hasAttributes
```
public boolean hasAttributes()
```
  - getAttributeIterator
```
public XMLAttributesIteratorImpl getAttributeIterator()
```
    return the attribute iterator implementation
  - standaloneSet
```
public boolean standaloneSet()
```
    return if standalone is set
  - isStandAlone
```
public boolean isStandAlone()
```
    return if the doucment is standalone
  - scanAttribute
```
protected void scanAttribute(XMLAttributes attributes)
                      throws IOException,
                             XNIException
```
    Scans an attribute name value pair.
```
 [41] Attribute ::= Name Eq AttValue
 
```
    Note: This method assumes that the next character on the stream is the first character of the attribute name.
    Note: This method uses the fAttributeQName and fQName variables. The contents of these variables will be destroyed.
    Parameters:
    attributes - The attributes list for the scanned attribute.
    
    Throws:
    
    IOException
    
    XNIException
  - scanContent
```
protected int scanContent(XMLStringBuffer content)
                   throws IOException,
                          XNIException
```
    Scans element content.
    
    Returns:
    Returns the next character on the stream.
    
    Throws:
    
    IOException
    
    XNIException
  - scanCDATASection
```
protected boolean scanCDATASection(XMLStringBuffer contentBuffer,
                       boolean complete)
                            throws IOException,
                                   XNIException
```
    Scans a CDATA section.
    Note: This method uses the fTempString and fStringBuffer variables.
    
    Parameters:
    complete - True if the CDATA section is to be scanned completely.
    
    Returns:
    True if CDATA is completely scanned.
    
    Throws:
    
    IOException
    
    XNIException
  - scanEndElement
```
protected int scanEndElement()
                      throws IOException,
                             XNIException
```
    Scans an end element.
```
 [42] ETag ::= '</' Name S? '>'
 
```
    Note: This method uses the fElementQName variable. The contents of this variable will be destroyed. The caller should copy the needed information out of this variable before calling this method.
    Returns:
    The element depth.
    
    Throws:
    
    IOException
    
    XNIException
  - scanCharReference
```
protected void scanCharReference()
                          throws IOException,
                                 XNIException
```
    Scans a character reference.
```
 [66] CharRef ::= '&#' [0-9]+ ';' | '&#x' [0-9a-fA-F]+ ';'
 
```
    Throws:
    
    IOException
    
    XNIException
  - scanEntityReference
```
protected void scanEntityReference(XMLStringBuffer content)
                            throws IOException,
                                   XNIException
```
    Scans an entity reference.
    
    Throws:
    
    IOException - Thrown if i/o error occurs.
    
    XNIException - Thrown if handler throws exception upon notification.
  - setScannerState
```
protected final void setScannerState(int state)
```
    Sets the scanner state.
    
    Parameters:
    state - The new scanner state.
  - setDriver
```
protected final void setDriver(XMLDocumentFragmentScannerImpl.Driver driver)
```
    Sets the Driver.
    
    Parameters:
    Driver - The new Driver.
  - getScannerStateName
```
protected String getScannerStateName(int state)
```
    Returns the scanner state name.
  - getEntityName
```
public String getEntityName()
```
  - getDriverName
```
public String getDriverName(XMLDocumentFragmentScannerImpl.Driver driver)
```
    Returns the driver name.
  - getString
```
protected XMLString getString()
```
    this function gets an XMLString (which is used to store the attribute value) from the special pool maintained for attributes. fAttributeCacheUsedCount tracks the number of attributes that has been consumed from the pool. if all the attributes has been consumed, it adds a new XMLString inthe pool and returns the same XMLString.
    
    Returns:
    XMLString XMLString used to store an attribute value.
  - refresh
```
public void refresh()
```
    Implements XMLBufferListener interface.
    
    Specified by:
    
    refresh in interface XMLBufferListener
  - refresh
```
public void refresh(int refreshPosition)
```
    receives callbacks from XMLEntityReader when buffer is being changed.
    
    Specified by:
    
    refresh in interface XMLBufferListener
    
    Parameters:
    refreshPosition -

Class XMLDocumentFragmentScannerImpl

Nested Class Summary

Field Summary

Fields inherited from class jdk7u.jaxp.org.apache.xerces.external.impl.XMLScanner

Constructor Summary

Method Summary

Methods inherited from class jdk7u.jaxp.org.apache.xerces.external.impl.XMLScanner

Methods inherited from class java.lang.Object

Field Detail

fElementAttributeLimit

fExternalSubsetResolver

SCANNER_STATE_START_OF_MARKUP

SCANNER_STATE_CONTENT

SCANNER_STATE_PI

SCANNER_STATE_DOCTYPE

SCANNER_STATE_XML_DECL

SCANNER_STATE_ROOT_ELEMENT

SCANNER_STATE_COMMENT

SCANNER_STATE_REFERENCE

SCANNER_STATE_ATTRIBUTE

SCANNER_STATE_ATTRIBUTE_VALUE

SCANNER_STATE_END_OF_INPUT

SCANNER_STATE_TERMINATED

SCANNER_STATE_CDATA

SCANNER_STATE_TEXT_DECL

SCANNER_STATE_CHARACTER_DATA

SCANNER_STATE_START_ELEMENT_TAG

SCANNER_STATE_END_ELEMENT_TAG

SCANNER_STATE_CHAR_REFERENCE

SCANNER_STATE_BUILT_IN_REFS

NOTIFY_BUILTIN_REFS

ENTITY_RESOLVER

STANDARD_URI_CONFORMANT

DEBUG_START_END_ELEMENT

DEBUG_NEXT

DEBUG

DEBUG_COALESCE

fDocumentHandler

fScannerLastState

fEntityStore

fEntityStack

fMarkupDepth

fEmptyElement

fReadingAttributes

fScannerState

fInScanContent

fLastSectionWasCData

fLastSectionWasEntityReference

fLastSectionWasCharacterData

fHasExternalDTD

fStandaloneSet

fStandalone

fVersion

fCurrentElement

fElementStack

fElementStack2

fPITarget

fPIData

fNotifyBuiltInRefs

fSupportDTD

fReplaceEntityReferences

fSupportExternalEntities

fReportCdataEvent

fIsCoalesce

fDeclaredEncoding

fDisallowDoctype

fAccessExternalDTD

fStrictURI

fDriver

fContentDriver

fElementQName

fAttributeQName

fAttributes

fTempString

fTempString2

fStringBuffer

fStringBuffer2

fContentBuffer

fScanToEnd

dtdGrammarUtil