Class DOMFragmentParser
- java.lang.Object
-
- org.htmlunit.cyberneko.parsers.DOMFragmentParser
-
- All Implemented Interfaces:
XMLDocumentHandler
public class DOMFragmentParser extends java.lang.Object implements XMLDocumentHandler
A DOM parser for HTML fragments.
-
-
Field Summary
Fields Modifier and Type Field Description private org.w3c.dom.Node
currentNode_
Current node.private org.w3c.dom.Document
document_
Document.private org.w3c.dom.DocumentFragment
documentFragment_
DOM document fragment.private XMLDocumentSource
documentSource_
protected static java.lang.String
ERROR_HANDLER
Property identifier: error handler.private boolean
inCDATASection_
True if within a CDATA section.private XMLParserConfiguration
parserConfiguration_
Parser configuration.protected static java.lang.String[]
RECOGNIZED_FEATURES
Recognized features.protected static java.lang.String[]
RECOGNIZED_PROPERTIES
Recognized properties.
-
Constructor Summary
Constructors Constructor Description DOMFragmentParser()
Default constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
characters(XMLString text, Augmentations augs)
Character content.void
comment(XMLString text, Augmentations augs)
A comment.void
doctypeDecl(java.lang.String root, java.lang.String pubid, java.lang.String sysid, Augmentations augs)
Notifies of the presence of the DOCTYPE line in the document.void
emptyElement(QName element, XMLAttributes attrs, Augmentations augs)
An empty element.void
endCDATA(Augmentations augs)
End CDATA section.void
endDocument(Augmentations augs)
End document.void
endElement(QName element, Augmentations augs)
End element.XMLDocumentSource
getDocumentSource()
org.xml.sax.ErrorHandler
getErrorHandler()
Return the current error handler.boolean
getFeature(java.lang.String featureId)
Query the state of a feature.XMLParserConfiguration
getXMLParserConfiguration()
void
parse(java.lang.String systemId, org.w3c.dom.DocumentFragment fragment)
Parses a document fragmentvoid
parse(org.xml.sax.InputSource source, org.w3c.dom.DocumentFragment fragment)
Parses a document fragmentvoid
processingInstruction(java.lang.String target, XMLString data, Augmentations augs)
A processing instruction.void
setDocumentSource(XMLDocumentSource source)
Sets the document source.void
setErrorHandler(org.xml.sax.ErrorHandler errorHandler)
Allow an application to register an error event handler.void
setFeature(java.lang.String featureId, boolean state)
Set the state of any feature in a SAX2 parser.void
setProperty(java.lang.String propertyId, java.lang.Object value)
Set the value of any property in a SAX2 parser.void
startCDATA(Augmentations augs)
Start CDATA section.void
startDocument(XMLLocator locator, java.lang.String encoding, NamespaceContext nscontext, Augmentations augs)
The start of the document.void
startElement(QName element, XMLAttributes attrs, Augmentations augs)
The start of an element.void
xmlDecl(java.lang.String version, java.lang.String encoding, java.lang.String standalone, Augmentations augs)
Notifies of the presence of an XMLDecl line in the document.
-
-
-
Field Detail
-
RECOGNIZED_FEATURES
protected static final java.lang.String[] RECOGNIZED_FEATURES
Recognized features.
-
ERROR_HANDLER
protected static final java.lang.String ERROR_HANDLER
Property identifier: error handler.- See Also:
- Constant Field Values
-
RECOGNIZED_PROPERTIES
protected static final java.lang.String[] RECOGNIZED_PROPERTIES
Recognized properties.
-
parserConfiguration_
private final XMLParserConfiguration parserConfiguration_
Parser configuration.
-
documentSource_
private XMLDocumentSource documentSource_
-
documentFragment_
private org.w3c.dom.DocumentFragment documentFragment_
DOM document fragment.
-
document_
private org.w3c.dom.Document document_
Document.
-
currentNode_
private org.w3c.dom.Node currentNode_
Current node.
-
inCDATASection_
private boolean inCDATASection_
True if within a CDATA section.
-
-
Method Detail
-
parse
public void parse(java.lang.String systemId, org.w3c.dom.DocumentFragment fragment) throws org.xml.sax.SAXException, java.io.IOException
Parses a document fragment- Parameters:
systemId
- systemIdfragment
- fragment- Throws:
org.xml.sax.SAXException
- in case of sax errorjava.io.IOException
- in case of io problems
-
parse
public void parse(org.xml.sax.InputSource source, org.w3c.dom.DocumentFragment fragment) throws org.xml.sax.SAXException, java.io.IOException
Parses a document fragment- Parameters:
source
- input sourcefragment
- fragment- Throws:
org.xml.sax.SAXException
- in case of sax errorjava.io.IOException
- in case of io problems
-
setErrorHandler
public void setErrorHandler(org.xml.sax.ErrorHandler errorHandler)
Allow an application to register an error event handler.If the application does not register an error handler, all error events reported by the SAX parser will be silently ignored; however, normal processing may not continue. It is highly recommended that all SAX applications implement an error handler to avoid unexpected bugs.
Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.
- Parameters:
errorHandler
- The error handler.- Throws:
java.lang.NullPointerException
- If the handler argument is null.- See Also:
getErrorHandler()
-
getErrorHandler
public org.xml.sax.ErrorHandler getErrorHandler()
Return the current error handler.- Returns:
- The current error handler, or null if none has been registered.
- See Also:
setErrorHandler(org.xml.sax.ErrorHandler)
-
setFeature
public void setFeature(java.lang.String featureId, boolean state) throws org.xml.sax.SAXNotRecognizedException, org.xml.sax.SAXNotSupportedException
Set the state of any feature in a SAX2 parser. The parser might not recognize the feature, and if it does recognize it, it might not be able to fulfill the request.- Parameters:
featureId
- The unique identifier (URI) of the feature.state
- The requested state of the feature (true or false).- Throws:
org.xml.sax.SAXNotRecognizedException
- If the requested feature is not known.org.xml.sax.SAXNotSupportedException
- If the requested feature is known, but the requested state is not supported.
-
getFeature
public boolean getFeature(java.lang.String featureId) throws org.xml.sax.SAXNotRecognizedException, org.xml.sax.SAXNotSupportedException
Query the state of a feature.Query the current state of any feature in a SAX2 parser. The parser might not recognize the feature.
- Parameters:
featureId
- The unique identifier (URI) of the feature being set.- Returns:
- The current state of the feature.
- Throws:
org.xml.sax.SAXNotRecognizedException
- If the requested feature is not known.org.xml.sax.SAXNotSupportedException
- If the requested feature is known but not supported.
-
setProperty
public void setProperty(java.lang.String propertyId, java.lang.Object value) throws org.xml.sax.SAXNotRecognizedException, org.xml.sax.SAXNotSupportedException
Set the value of any property in a SAX2 parser. The parser might not recognize the property, and if it does recognize it, it might not support the requested value.- Parameters:
propertyId
- The unique identifier (URI) of the property being set.value
- The value to which the property is being set.- Throws:
org.xml.sax.SAXNotRecognizedException
- If the requested property is not known.org.xml.sax.SAXNotSupportedException
- If the requested property is known, but the requested value is not supported.
-
startDocument
public void startDocument(XMLLocator locator, java.lang.String encoding, NamespaceContext nscontext, Augmentations augs) throws XNIException
Description copied from interface:XMLDocumentHandler
The start of the document.- Specified by:
startDocument
in interfaceXMLDocumentHandler
- Parameters:
locator
- The document locator, or null if the document location cannot be reported during the parsing of this document. However, it is strongly recommended that a locator be supplied that can at least report the system identifier of the document.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).nscontext
- The namespace context in effect at the start of this document. This object represents the current context. Implementors of this class are responsible for copying the namespace bindings from the the current context (and its parent contexts) if that information is important.augs
- Additional information that may include infoset augmentations- Throws:
XNIException
- Thrown by handler to signal an error.
-
xmlDecl
public void xmlDecl(java.lang.String version, java.lang.String encoding, java.lang.String standalone, Augmentations augs) throws XNIException
Description copied from interface:XMLDocumentHandler
Notifies of the presence of an XMLDecl line in the document. If present, this method will be called immediately following the startDocument call.- Specified by:
xmlDecl
in interfaceXMLDocumentHandler
- Parameters:
version
- The XML version.encoding
- The IANA encoding name of the document, or null if not specified.standalone
- The standalone value, or null if not specified.augs
- Additional information that may include infoset augmentations- Throws:
XNIException
- Thrown by handler to signal an error.
-
doctypeDecl
public void doctypeDecl(java.lang.String root, java.lang.String pubid, java.lang.String sysid, Augmentations augs) throws XNIException
Description copied from interface:XMLDocumentHandler
Notifies of the presence of the DOCTYPE line in the document.- Specified by:
doctypeDecl
in interfaceXMLDocumentHandler
- Parameters:
root
- The name of the root element.pubid
- The public identifier if an external DTD or null if the external DTD is specified using SYSTEM.sysid
- The system identifier if an external DTD, null otherwise.augs
- Additional information that may include infoset augmentations- Throws:
XNIException
- Thrown by handler to signal an error.
-
processingInstruction
public void processingInstruction(java.lang.String target, XMLString data, Augmentations augs) throws XNIException
Description copied from interface:XMLDocumentHandler
A processing instruction. Processing instructions consist of a target name and, optionally, text data. The data is only meaningful to the application.Typically, a processing instruction's data will contain a series of pseudo-attributes. These pseudo-attributes follow the form of element attributes but are not parsed or presented to the application as anything other than text. The application is responsible for parsing the data.
- Specified by:
processingInstruction
in interfaceXMLDocumentHandler
- Parameters:
target
- The target.data
- The data or null if none specified.augs
- Additional information that may include infoset augmentations- Throws:
XNIException
- Thrown by handler to signal an error.
-
comment
public void comment(XMLString text, Augmentations augs) throws XNIException
Description copied from interface:XMLDocumentHandler
A comment.- Specified by:
comment
in interfaceXMLDocumentHandler
- Parameters:
text
- The text in the comment.augs
- Additional information that may include infoset augmentations- Throws:
XNIException
- Thrown by application to signal an error.
-
startElement
public void startElement(QName element, XMLAttributes attrs, Augmentations augs) throws XNIException
Description copied from interface:XMLDocumentHandler
The start of an element.- Specified by:
startElement
in interfaceXMLDocumentHandler
- Parameters:
element
- The name of the element.attrs
- The element attributes.augs
- Additional information that may include infoset augmentations- Throws:
XNIException
- Thrown by handler to signal an error.
-
emptyElement
public void emptyElement(QName element, XMLAttributes attrs, Augmentations augs) throws XNIException
Description copied from interface:XMLDocumentHandler
An empty element.- Specified by:
emptyElement
in interfaceXMLDocumentHandler
- Parameters:
element
- The name of the element.attrs
- The element attributes.augs
- Additional information that may include infoset augmentations- Throws:
XNIException
- Thrown by handler to signal an error.
-
characters
public void characters(XMLString text, Augmentations augs) throws XNIException
Description copied from interface:XMLDocumentHandler
Character content.- Specified by:
characters
in interfaceXMLDocumentHandler
- Parameters:
text
- The content.augs
- Additional information that may include infoset augmentations- Throws:
XNIException
- Thrown by handler to signal an error.
-
startCDATA
public void startCDATA(Augmentations augs) throws XNIException
Start CDATA section.- Specified by:
startCDATA
in interfaceXMLDocumentHandler
- Parameters:
augs
- Additional information that may include infoset augmentations- Throws:
XNIException
- Thrown by handler to signal an error.
-
endCDATA
public void endCDATA(Augmentations augs) throws XNIException
End CDATA section.- Specified by:
endCDATA
in interfaceXMLDocumentHandler
- Parameters:
augs
- Additional information that may include infoset augmentations- Throws:
XNIException
- Thrown by handler to signal an error.
-
endElement
public void endElement(QName element, Augmentations augs) throws XNIException
End element.- Specified by:
endElement
in interfaceXMLDocumentHandler
- Parameters:
element
- The name of the element.augs
- Additional information that may include infoset augmentations- Throws:
XNIException
- Thrown by handler to signal an error.
-
endDocument
public void endDocument(Augmentations augs) throws XNIException
End document.- Specified by:
endDocument
in interfaceXMLDocumentHandler
- Parameters:
augs
- Additional information that may include infoset augmentations- Throws:
XNIException
- Thrown by handler to signal an error.
-
getXMLParserConfiguration
public XMLParserConfiguration getXMLParserConfiguration()
- Returns:
- the XMLParserConfiguration
-
setDocumentSource
public void setDocumentSource(XMLDocumentSource source)
Sets the document source.- Specified by:
setDocumentSource
in interfaceXMLDocumentHandler
- Parameters:
source
- the new source
-
getDocumentSource
public XMLDocumentSource getDocumentSource()
- Specified by:
getDocumentSource
in interfaceXMLDocumentHandler
- Returns:
- the document source.
-
-