Module org.htmlunit.cyberneko

Package org.htmlunit.cyberneko.xerces.parsers

Class AbstractSAXParser

java.lang.Object

org.htmlunit.cyberneko.xerces.parsers.AbstractXMLDocumentParser

org.htmlunit.cyberneko.xerces.parsers.AbstractSAXParser

All Implemented Interfaces:

XMLDocumentHandler, XMLReader

Direct Known Subclasses:

SAXParser

public abstract class AbstractSAXParser
extends AbstractXMLDocumentParser
implements XMLReader

Base class of all SAX parsers. It implements both SAX1 and SAX2 parser functionality, while the actual pipeline is defined in the parser configuration.

Author:

Arnaud Le Hors, IBM, Andy Clark, IBM, Ronald Brill

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	fLexicalHandlerParameterEntities	Lexical handler parameter entities.
protected NamespaceContext	fNamespaceContext	Namespace context.
protected boolean	fNamespacePrefixes	Namespace prefixes.
protected boolean	fNamespaces	Namespaces.
protected boolean	fStandalone	Standalone document declaration.
protected String	fVersion
protected static final String	LEXICAL_HANDLER	Property id: lexical handler.
protected static final String	NAMESPACES	Feature identifier: namespaces.

Fields inherited from class org.htmlunit.cyberneko.xerces.parsers.AbstractXMLDocumentParser

ERROR_HANDLER, parserConfiguration_

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSAXParser(XMLParserConfiguration config)	Constructs an abstract SAX parser with the specified configuration.

Method Summary

Modifier and Type	Method	Description
void	characters(XMLString text, Augmentations augs)	Character content.
void	comment(XMLString text, Augmentations augs)	A comment.
void	doctypeDecl(String rootElement, String publicId, String systemId, Augmentations augs)	Notifies of the presence of the DOCTYPE line in the document.
void	endCDATA(Augmentations augs)	The end of a CDATA section.
void	endDocument(Augmentations augs)	The end of the document.
void	endElement(QName element, Augmentations augs)	The end of an element.
protected final void	endNamespaceMapping()	Sends endPrefixMapping events.
ContentHandler	getContentHandler()	Returns the current content handler.
DTDHandler	getDTDHandler()	Returns the current DTD handler.
EntityResolver	getEntityResolver()	Returns the current entity resolver.
ErrorHandler	getErrorHandler()	Returns the current error handler.
boolean	getFeature(String featureId)	Queries the state of a feature.
protected LexicalHandler	getLexicalHandler()	Returns the lexical event handler.
Object	getProperty(String propertyId)	Queries the value of a property.
void	parse(String systemId)	Parses the input source specified by the given system identifier.
void	parse(InputSource inputSource)
void	processingInstruction(String target, XMLString data, Augmentations augs)	A processing instruction.
void	reset()	Resets all components before parsing.
void	setContentHandler(ContentHandler contentHandler)	Allows an application to register a content event handler.
void	setDTDHandler(DTDHandler dtdHandler)	Allows an application to register a DTD event handler.
void	setEntityResolver(EntityResolver resolver)
void	setErrorHandler(ErrorHandler errorHandler)	Allows an application to register an error event handler.
void	setFeature(String featureId, boolean state)	Sets the state of any feature in a SAX2 parser.
protected void	setLexicalHandler(LexicalHandler handler)	Sets the lexical event handler.
void	setProperty(String propertyId, Object value)	Sets the value of any property in a SAX2 parser.
void	startCDATA(Augmentations augs)	The start of a CDATA section.
void	startDocument(XMLLocator locator, String encoding, NamespaceContext namespaceContext, Augmentations augs)	The start of the document.
void	startElement(QName element, XMLAttributes attributes, Augmentations augs)	The start of an element.
protected final void	startNamespaceMapping()	Sends startPrefixMapping events.
void	xmlDecl(String version, String encoding, String standalone, Augmentations augs)	Notifies of the presence of an XMLDecl line in the document.

Methods inherited from class org.htmlunit.cyberneko.xerces.parsers.AbstractXMLDocumentParser

emptyElement, getDocumentSource, parse, setDocumentSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NAMESPACES

protected static final String NAMESPACES

Feature identifier: namespaces.

See Also:

• Constant Field Values

LEXICAL_HANDLER

protected static final String LEXICAL_HANDLER

Property id: lexical handler.

See Also:

• Constant Field Values

fNamespaces

protected boolean fNamespaces

Namespaces.

fNamespacePrefixes

protected boolean fNamespacePrefixes

Namespace prefixes.

fLexicalHandlerParameterEntities

protected boolean fLexicalHandlerParameterEntities

Lexical handler parameter entities.

fStandalone

protected boolean fStandalone

Standalone document declaration.

fNamespaceContext

protected NamespaceContext fNamespaceContext

Namespace context.

fVersion

protected String fVersion

Constructor Details

AbstractSAXParser

protected AbstractSAXParser(XMLParserConfiguration config)

Constructs an abstract SAX parser with the specified configuration.

Parameters:

config - the parser configuration

Method Details

startDocument

public void startDocument(XMLLocator locator,
 String encoding,
 NamespaceContext namespaceContext,
 Augmentations augs)
                   throws XNIException

The start of the document.

Specified by:

startDocument in interface XMLDocumentHandler

Overrides:

startDocument in class AbstractXMLDocumentParser

Parameters:

locator - the document locator, or null if location cannot be reported. 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, or null if not auto-detected

namespaceContext - the namespace context in effect at the start of this document

augs - additional information that may include infoset augmentations

Throws:

XNIException - thrown by handler to signal an error

xmlDecl

public void xmlDecl(String version,
 String encoding,
 String standalone,
 Augmentations augs)
             throws XNIException

Notifies of the presence of an XMLDecl line in the document. If present, this method is called immediately following the startDocument call.

Specified by:

xmlDecl in interface XMLDocumentHandler

Overrides:

xmlDecl in class AbstractXMLDocumentParser

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(String rootElement,
 String publicId,
 String systemId,
 Augmentations augs)
                 throws XNIException

Notifies of the presence of the DOCTYPE line in the document.

Specified by:

doctypeDecl in interface XMLDocumentHandler

Overrides:

doctypeDecl in class AbstractXMLDocumentParser

Parameters:

rootElement - the name of the root element

publicId - the public identifier if an external DTD, or null if specified using SYSTEM

systemId - the system identifier if an external DTD, or null otherwise

augs - additional information that may include infoset augmentations

Throws:

XNIException - thrown by handler to signal an error

startElement

public void startElement(QName element,
 XMLAttributes attributes,
 Augmentations augs)
                  throws XNIException

The start of an element. If the document specifies the start element by using an empty tag, the startElement method is immediately followed by the endElement method, with no intervening methods.

Specified by:

startElement in interface XMLDocumentHandler

Overrides:

startElement in class AbstractXMLDocumentParser

Parameters:

element - the name of the element

attributes - 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

Character content.

Specified by:

characters in interface XMLDocumentHandler

Overrides:

characters in class AbstractXMLDocumentParser

Parameters:

text - the content

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

The end of an element.

Specified by:

endElement in interface XMLDocumentHandler

Overrides:

endElement in class AbstractXMLDocumentParser

Parameters:

element - the name of the element

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

The start of a CDATA section.

Specified by:

startCDATA in interface XMLDocumentHandler

Overrides:

startCDATA in class AbstractXMLDocumentParser

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

The end of a CDATA section.

Specified by:

endCDATA in interface XMLDocumentHandler

Overrides:

endCDATA in class AbstractXMLDocumentParser

Parameters:

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

A comment.

Specified by:

comment in interface XMLDocumentHandler

Overrides:

comment in class AbstractXMLDocumentParser

Parameters:

text - the text in the comment

augs - additional information that may include infoset augmentations

Throws:

XNIException - thrown by application to signal an error

processingInstruction

public void processingInstruction(String target,
 XMLString data,
 Augmentations augs)
                           throws XNIException

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 contains 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 interface XMLDocumentHandler

Overrides:

processingInstruction in class AbstractXMLDocumentParser

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

endDocument

public void endDocument(Augmentations augs)
                 throws XNIException

The end of the document.

Specified by:

endDocument in interface XMLDocumentHandler

Overrides:

endDocument in class AbstractXMLDocumentParser

Parameters:

augs - additional information that may include infoset augmentations

Throws:

XNIException - thrown by handler to signal an error

parse

public void parse(String systemId)
           throws SAXException,
IOException

Parses the input source specified by the given system identifier.

This method is equivalent to the following:

 parse(new InputSource(systemId));
 

Specified by:

parse in interface XMLReader

Parameters:

systemId - the system identifier (URI)

Throws:

SAXException - thrown on SAX error

IOException - thrown on I/O error

parse

public void parse(InputSource inputSource)
           throws SAXException,
IOException

Specified by:

parse in interface XMLReader

Throws:

SAXException

IOException

setEntityResolver

public void setEntityResolver(EntityResolver resolver)

Specified by:

setEntityResolver in interface XMLReader

getEntityResolver

public EntityResolver getEntityResolver()

Returns the current entity resolver.

Specified by:

getEntityResolver in interface XMLReader

Returns:

the current entity resolver, or null if none has been registered

See Also:

• setEntityResolver(EntityResolver)

setErrorHandler

public void setErrorHandler(ErrorHandler errorHandler)

Allows 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 are 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.

Specified by:

setErrorHandler in interface XMLReader

Parameters:

errorHandler - the error handler

See Also:

• getErrorHandler()

getErrorHandler

public ErrorHandler getErrorHandler()

Returns the current error handler.

Specified by:

getErrorHandler in interface XMLReader

Returns:

the current error handler, or null if none has been registered

See Also:

• setErrorHandler(ErrorHandler)

setDTDHandler

public void setDTDHandler(DTDHandler dtdHandler)

Allows an application to register a DTD event handler.

If the application does not register a DTD handler, all DTD events reported by the SAX parser are silently ignored.

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.

Specified by:

setDTDHandler in interface XMLReader

Parameters:

dtdHandler - the DTD handler

See Also:

• getDTDHandler()

setContentHandler

public void setContentHandler(ContentHandler contentHandler)

Allows an application to register a content event handler.

If the application does not register a content handler, all content events reported by the SAX parser are silently ignored.

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.

Specified by:

setContentHandler in interface XMLReader

Parameters:

contentHandler - the content handler

See Also:

• getContentHandler()

getContentHandler

public ContentHandler getContentHandler()

Returns the current content handler.

Specified by:

getContentHandler in interface XMLReader

Returns:

the current content handler, or null if none has been registered

See Also:

• setContentHandler(ContentHandler)

getDTDHandler

public DTDHandler getDTDHandler()

Returns the current DTD handler.

Specified by:

getDTDHandler in interface XMLReader

Returns:

the current DTD handler, or null if none has been registered

See Also:

• setDTDHandler(DTDHandler)

setFeature

public void setFeature(String featureId,
 boolean state)
                throws SAXNotRecognizedException,
SAXNotSupportedException

Sets the state of any feature in a SAX2 parser. The parser might not recognize the feature, and if recognized, might not be able to fulfill the request.

Specified by:

setFeature in interface XMLReader

Parameters:

featureId - the unique identifier (URI) of the feature

state - the requested state of the feature (true or false)

Throws:

SAXNotRecognizedException - if the requested feature is not known

SAXNotSupportedException - if the requested feature is known, but the requested state is not supported

getFeature

public boolean getFeature(String featureId)
                   throws SAXNotRecognizedException,
SAXNotSupportedException

Queries the state of a feature.

Queries the current state of any feature in a SAX2 parser. The parser might not recognize the feature.

Specified by:

getFeature in interface XMLReader

Parameters:

featureId - the unique identifier (URI) of the feature being queried

Returns:

the current state of the feature

Throws:

SAXNotRecognizedException - if the requested feature is not known

SAXNotSupportedException - if the requested feature is known but not supported

setProperty

public void setProperty(String propertyId,
 Object value)
                 throws SAXNotRecognizedException,
SAXNotSupportedException

Sets the value of any property in a SAX2 parser. The parser might not recognize the property, and if recognized, might not support the requested value.

Specified by:

setProperty in interface XMLReader

Parameters:

propertyId - the unique identifier (URI) of the property being set

value - the value to which the property is being set

Throws:

SAXNotRecognizedException - if the requested property is not known

SAXNotSupportedException - if the requested property is known, but the requested value is not supported

getProperty

public Object getProperty(String propertyId)
                   throws SAXNotRecognizedException,
SAXNotSupportedException

Queries the value of a property.

Returns the current value of a property in a SAX2 parser. The parser might not recognize the property.

Specified by:

getProperty in interface XMLReader

Parameters:

propertyId - the unique identifier (URI) of the property being queried

Returns:

the current value of the property

Throws:

SAXNotRecognizedException - if the requested property is not known

SAXNotSupportedException - if the requested property is known but not supported

setLexicalHandler

protected void setLexicalHandler(LexicalHandler handler)
                          throws SAXNotSupportedException

Sets the lexical event handler.

This method is the equivalent to the property:

 http://xml.org/sax/properties/lexical-handler
 

Parameters:

handler - the lexical event handler

Throws:

SAXNotSupportedException - on error

See Also:

• getLexicalHandler()
• setProperty(String, Object)

getLexicalHandler

protected LexicalHandler getLexicalHandler()

Returns the lexical event handler.

Returns:

the lexical handler, or null if none is set

See Also:

• setLexicalHandler(LexicalHandler)

startNamespaceMapping

protected final void startNamespaceMapping()
                                    throws SAXException

Sends startPrefixMapping events.

Throws:

SAXException - on error

endNamespaceMapping

protected final void endNamespaceMapping()
                                  throws SAXException

Sends endPrefixMapping events.

Throws:

SAXException - on error

reset

public void reset()
           throws XNIException

Resets all components before parsing.

Overrides:

reset in class AbstractXMLDocumentParser

Throws:

XNIException - thrown if an error occurs during initialization