ParserAdapter

public class ParserAdapter extends Object
implements XMLReader DocumentHandler

Adapt a SAX1 Parser as a SAX2 XMLReader.

This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY. See http://www.saxproject.org for further information.

This class wraps a SAX1 Parser and makes it act as a SAX2 XMLReader, with feature, property, and Namespace support. Note that it is not possible to report skippedEntity events, since SAX1 does not make that information available.

This adapter does not test for duplicate Namespace-qualified attribute names.

See Also

• XMLReaderAdapter
• XMLReader
• Parser

Public Constructor Summary

	ParserAdapter() Construct a new parser adapter.
	ParserAdapter(Parser parser) Construct a new parser adapter.

Public Method Summary

void	characters(char[] ch, int start, int length) Adapter implementation method; do not call.
void	endDocument() Adapter implementation method; do not call.
void	endElement(String qName) Adapter implementation method; do not call.
ContentHandler	getContentHandler() Return the current content handler.
DTDHandler	getDTDHandler() Return the current DTD handler.
EntityResolver	getEntityResolver() Return the current entity resolver.
ErrorHandler	getErrorHandler() Return the current error handler.
boolean	getFeature(String name) Check a parser feature flag.
Object	getProperty(String name) Get a parser property.
void	ignorableWhitespace(char[] ch, int start, int length) Adapter implementation method; do not call.
void	parse(InputSource input) Parse an XML document.
void	parse(String systemId) Parse an XML document.
void	processingInstruction(String target, String data) Adapter implementation method; do not call.
void	setContentHandler(ContentHandler handler) Set the content handler.
void	setDTDHandler(DTDHandler handler) Set the DTD handler.
void	setDocumentLocator(Locator locator) Adapter implementation method; do not call.
void	setEntityResolver(EntityResolver resolver) Set the entity resolver.
void	setErrorHandler(ErrorHandler handler) Set the error handler.
void	setFeature(String name, boolean value) Set a feature flag for the parser.
void	setProperty(String name, Object value) Set a parser property.
void	startDocument() Adapter implementation method; do not call.
void	startElement(String qName, AttributeList qAtts) Adapter implementation method; do not call.

Inherited Method Summary

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

From interface org.xml.sax.XMLReader

abstract ContentHandler	getContentHandler() Return the current content handler.
abstract DTDHandler	getDTDHandler() Return the current DTD handler.
abstract EntityResolver	getEntityResolver() Return the current entity resolver.
abstract ErrorHandler	getErrorHandler() Return the current error handler.
abstract boolean	getFeature(String name) Look up the value of a feature flag.
abstract Object	getProperty(String name) Look up the value of a property.
abstract void	parse(InputSource input) Parse an XML document.
abstract void	parse(String systemId) Parse an XML document from a system identifier (URI).
abstract void	setContentHandler(ContentHandler handler) Allow an application to register a content event handler.
abstract void	setDTDHandler(DTDHandler handler) Allow an application to register a DTD event handler.
abstract void	setEntityResolver(EntityResolver resolver) Allow an application to register an entity resolver.
abstract void	setErrorHandler(ErrorHandler handler) Allow an application to register an error event handler.
abstract void	setFeature(String name, boolean value) Set the value of a feature flag.
abstract void	setProperty(String name, Object value) Set the value of a property.

From interface org.xml.sax.DocumentHandler

abstract void	characters(char[] ch, int start, int length) Receive notification of character data.
abstract void	endDocument() Receive notification of the end of a document.
abstract void	endElement(String name) Receive notification of the end of an element.
abstract void	ignorableWhitespace(char[] ch, int start, int length) Receive notification of ignorable whitespace in element content.
abstract void	processingInstruction(String target, String data) Receive notification of a processing instruction.
abstract void	setDocumentLocator(Locator locator) Receive an object for locating the origin of SAX document events.
abstract void	startDocument() Receive notification of the beginning of a document.
abstract void	startElement(String name, AttributeList atts) Receive notification of the beginning of an element.

Public Constructors

public ParserAdapter ()

Construct a new parser adapter.

Use the "org.xml.sax.parser" property to locate the embedded SAX1 driver.

Throws

SAXException	If the embedded driver cannot be instantiated or if the org.xml.sax.parser property is not specified.

public ParserAdapter (Parser parser)

Construct a new parser adapter.

Note that the embedded parser cannot be changed once the adapter is created; to embed a different parser, allocate a new ParserAdapter.

Parameters

parser	The SAX1 parser to embed.

Throws

NullPointerException	If the parser parameter is null.

Public Methods

public void characters (char[] ch, int start, int length)

Adapter implementation method; do not call. Adapt a SAX1 characters event.

Parameters

ch	An array of characters.
start	The starting position in the array.
length	The number of characters to use.

Throws

SAXException	The client may raise a processing exception.

See Also

• DocumentHandler.characters(char[], int, int)

public void endDocument ()

Adapter implementation method; do not call. Adapt a SAX1 end document event.

Throws

SAXException	The client may raise a processing exception.

See Also

• DocumentHandler.endDocument()

public void endElement (String qName)

Adapter implementation method; do not call. Adapt a SAX1 end element event.

Parameters

qName	The qualified (prefixed) name.

Throws

SAXException	The client may raise a processing exception.

See Also

• DocumentHandler.endElement(String)

public ContentHandler getContentHandler ()

Return the current content handler.

Returns

• The current content handler, or null if none was supplied.

See Also

• XMLReader.getEntityResolver()

public DTDHandler getDTDHandler ()

Return the current DTD handler.

Returns

• the current DTD handler, or null if none was supplied

See Also

• XMLReader.getEntityResolver()

public EntityResolver getEntityResolver ()

Return the current entity resolver.

Returns

• The current entity resolver, or null if none was supplied.

See Also

• XMLReader.getEntityResolver()

public ErrorHandler getErrorHandler ()

Return the current error handler.

Returns

• The current error handler, or null if none was supplied.

See Also

• XMLReader.getEntityResolver()

public boolean getFeature (String name)

Check a parser feature flag.

The only features recognized are namespaces and namespace-prefixes.

Parameters

name	The feature name, as a complete URI.

Returns

• The current feature value.

Throws

SAXNotRecognizedException	If the feature value can't be assigned or retrieved.
SAXNotSupportedException	If the feature is not currently readable.

See Also

• XMLReader.setFeature(String, boolean)

public Object getProperty (String name)

Get a parser property.

No properties are currently recognized.

Parameters

name	The property name.

Returns

• The property value.

Throws

SAXNotRecognizedException	If the property value can't be assigned or retrieved.
SAXNotSupportedException	If the property value is not currently readable.

See Also

• XMLReader.getProperty(String)

public void ignorableWhitespace (char[] ch, int start, int length)

Adapter implementation method; do not call. Adapt a SAX1 ignorable whitespace event.

Parameters

ch	An array of characters.
start	The starting position in the array.
length	The number of characters to use.

Throws

SAXException	The client may raise a processing exception.

See Also

• DocumentHandler.ignorableWhitespace(char[], int, int)

public void parse (InputSource input)

Parse an XML document.

Parameters

input	An input source for the document.

Throws

IOException	If there is a problem reading the raw content of the document.
SAXException	If there is a problem processing the document.

See Also

• parse(java.lang.String)
• Parser.parse(org.xml.sax.InputSource)

public void parse (String systemId)

Parse an XML document.

Parameters

systemId	The absolute URL of the document.

Throws

IOException	If there is a problem reading the raw content of the document.
SAXException	If there is a problem processing the document.

See Also

• parse(org.xml.sax.InputSource)
• Parser.parse(java.lang.String)

public void processingInstruction (String target, String data)

Adapter implementation method; do not call. Adapt a SAX1 processing instruction event.

Parameters

target	The processing instruction target.
data	The remainder of the processing instruction

Throws

SAXException	The client may raise a processing exception.

See Also

• DocumentHandler.processingInstruction(String, String)

public void setContentHandler (ContentHandler handler)

Set the content handler.

Parameters

handler	the new content handler

See Also

• XMLReader.setEntityResolver(EntityResolver)

public void setDTDHandler (DTDHandler handler)

Set the DTD handler.

Parameters

handler	the new DTD handler

See Also

• XMLReader.setEntityResolver(EntityResolver)

public void setDocumentLocator (Locator locator)

Adapter implementation method; do not call. Adapt a SAX1 document locator event.

Parameters

locator	A document locator.

See Also

• ContentHandler.setDocumentLocator(Locator)

public void setEntityResolver (EntityResolver resolver)

Set the entity resolver.

Parameters

resolver	The new entity resolver.

See Also

• XMLReader.setEntityResolver(EntityResolver)

public void setErrorHandler (ErrorHandler handler)

Set the error handler.

Parameters

handler	The new error handler.

See Also

• XMLReader.setEntityResolver(EntityResolver)

public void setFeature (String name, boolean value)

Set a feature flag for the parser.

The only features recognized are namespaces and namespace-prefixes.

Parameters

name	The feature name, as a complete URI.
value	The requested feature value.

Throws

SAXNotRecognizedException	If the feature can't be assigned or retrieved.
SAXNotSupportedException	If the feature can't be assigned that value.

See Also

• XMLReader.setFeature(String, boolean)

public void setProperty (String name, Object value)

Set a parser property.

No properties are currently recognized.

Parameters

name	The property name.
value	The property value.

Throws

SAXNotRecognizedException	If the property value can't be assigned or retrieved.
SAXNotSupportedException	If the property can't be assigned that value.

See Also

• XMLReader.setProperty(String, Object)

public void startDocument ()

Adapter implementation method; do not call. Adapt a SAX1 start document event.

Throws

SAXException	The client may raise a processing exception.

See Also

• DocumentHandler.startDocument()

public void startElement (String qName, AttributeList qAtts)

Adapter implementation method; do not call. Adapt a SAX1 startElement event.

If necessary, perform Namespace processing.

Parameters

qName	The qualified (prefixed) name.
qAtts	The XML attribute list (with qnames).

Throws

SAXException	The client may raise a processing exception.