javanet.staxutils

Class StAXEventContentHandler

java.lang.Object

org.xml.sax.helpers.DefaultHandler

javanet.staxutils.StAXContentHandler

javanet.staxutils.StAXEventContentHandler

All Implemented Interfaces:

org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler, org.xml.sax.ext.LexicalHandler

public class StAXEventContentHandler
extends StAXContentHandler

SAX ContentHandler that writes events to a StAX XMLEventConsumer.

Version:

$Revision: 1.5 $

Author:

Christian Niles

Field Summary

Fields inherited from class javanet.staxutils.StAXContentHandler

CDATABuffer, docLocator, isCDATA, namespaces, reporter

Constructor Summary

Constructors

Constructor and Description
StAXEventContentHandler() Constructs a default instance with a default event factory.
StAXEventContentHandler(javax.xml.stream.util.XMLEventConsumer consumer) Constructs an instance that writes events to the provided XMLEventConsumer.
StAXEventContentHandler(javax.xml.stream.util.XMLEventConsumer consumer, javax.xml.stream.XMLEventFactory factory) Constructs an instance that writes events constructed with the provided XMLEventFactory to the provided XMLEventConsumer

Method Summary

Methods

Modifier and Type	Method and Description
void	characters(char[] ch, int start, int length)
void	comment(char[] ch, int start, int length)
protected javax.xml.stream.events.Namespace	createNamespace(java.lang.String prefix, java.lang.String uri)
protected void	createStartEvents(org.xml.sax.Attributes attributes, java.util.Collection[] events) Creates the Namespaceand Attributeevents associated with a StartElement.
void	endCDATA()
void	endDocument()
void	endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName)
javax.xml.stream.util.XMLEventConsumer	getEventConsumer() Returns a reference to the XMLEventConsumer to which events will be written.
javax.xml.stream.XMLEventFactory	getEventFactory() Returns a reference to the XMLEventFactory used to construct events.
void	ignorableWhitespace(char[] ch, int start, int length)
void	processingInstruction(java.lang.String target, java.lang.String data)
void	setEventConsumer(javax.xml.stream.util.XMLEventConsumer consumer) Sets the XMLEventConsumer to which events are written.
void	setEventFactory(javax.xml.stream.XMLEventFactory factory) Sets the XMLEventFactory used to create events.
void	startDocument()
void	startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes attributes)

Methods inherited from class javanet.staxutils.StAXContentHandler

endDTD, endEntity, endPrefixMapping, error, fatalError, getCurrentLocation, parseQName, reportException, setDocumentLocator, setXMLReporter, startCDATA, startDTD, startEntity, startPrefixMapping, warning

Methods inherited from class org.xml.sax.helpers.DefaultHandler

notationDecl, resolveEntity, skippedEntity, unparsedEntityDecl

Methods inherited from class java.lang.Object

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

Constructor Detail

StAXEventContentHandler

public StAXEventContentHandler()

Constructs a default instance with a default event factory. You must set the XMLEventConsumervia the setEventConsumer(XMLEventConsumer)method.

StAXEventContentHandler

public StAXEventContentHandler(javax.xml.stream.util.XMLEventConsumer consumer)

Constructs an instance that writes events to the provided XMLEventConsumer. Events will be constructed from a default XMLEventFactory instance.

Parameters:

consumer - The XMLEventConsumerto which events will be written.

StAXEventContentHandler

public StAXEventContentHandler(javax.xml.stream.util.XMLEventConsumer consumer,
                       javax.xml.stream.XMLEventFactory factory)

Constructs an instance that writes events constructed with the provided XMLEventFactory to the provided XMLEventConsumer

Parameters:

consumer - The XMLEventConsumer to which events will be written.

factory - The XMLEventFactory used to construct events. If null, a default instance will be constructed.

Method Detail

getEventConsumer

public javax.xml.stream.util.XMLEventConsumer getEventConsumer()

Returns a reference to the XMLEventConsumer to which events will be written.

Returns:

The XMLEventConsumer to which events will be written.

setEventConsumer

public void setEventConsumer(javax.xml.stream.util.XMLEventConsumer consumer)

Sets the XMLEventConsumer to which events are written.

Parameters:

consumer - The XMLEventConsumer to which events will be written.

getEventFactory

public javax.xml.stream.XMLEventFactory getEventFactory()

Returns a reference to the XMLEventFactory used to construct events.

Returns:

The XMLEventFactory used to construct events.

setEventFactory

public void setEventFactory(javax.xml.stream.XMLEventFactory factory)

Sets the XMLEventFactory used to create events.

Parameters:

factory - The XMLEventFactory used to create events.

startDocument

public void startDocument()
                   throws org.xml.sax.SAXException

Specified by:

startDocument in interface org.xml.sax.ContentHandler

Overrides:

startDocument in class StAXContentHandler

Throws:

org.xml.sax.SAXException

endDocument

public void endDocument()
                 throws org.xml.sax.SAXException

Specified by:

endDocument in interface org.xml.sax.ContentHandler

Overrides:

endDocument in class StAXContentHandler

Throws:

org.xml.sax.SAXException

startElement

public void startElement(java.lang.String uri,
                java.lang.String localName,
                java.lang.String qName,
                org.xml.sax.Attributes attributes)
                  throws org.xml.sax.SAXException

Specified by:

startElement in interface org.xml.sax.ContentHandler

Overrides:

startElement in class StAXContentHandler

Throws:

org.xml.sax.SAXException

endElement

public void endElement(java.lang.String uri,
              java.lang.String localName,
              java.lang.String qName)
                throws org.xml.sax.SAXException

Specified by:

endElement in interface org.xml.sax.ContentHandler

Overrides:

endElement in class StAXContentHandler

Throws:

org.xml.sax.SAXException

comment

public void comment(char[] ch,
           int start,
           int length)
             throws org.xml.sax.SAXException

Specified by:

comment in interface org.xml.sax.ext.LexicalHandler

Overrides:

comment in class StAXContentHandler

Throws:

org.xml.sax.SAXException

characters

public void characters(char[] ch,
              int start,
              int length)
                throws org.xml.sax.SAXException

Specified by:

characters in interface org.xml.sax.ContentHandler

Overrides:

characters in class StAXContentHandler

Throws:

org.xml.sax.SAXException

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
                       int start,
                       int length)
                         throws org.xml.sax.SAXException

Specified by:

ignorableWhitespace in interface org.xml.sax.ContentHandler

Overrides:

ignorableWhitespace in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

processingInstruction

public void processingInstruction(java.lang.String target,
                         java.lang.String data)
                           throws org.xml.sax.SAXException

Specified by:

processingInstruction in interface org.xml.sax.ContentHandler

Overrides:

processingInstruction in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

endCDATA

public void endCDATA()
              throws org.xml.sax.SAXException

Specified by:

endCDATA in interface org.xml.sax.ext.LexicalHandler

Overrides:

endCDATA in class StAXContentHandler

Throws:

org.xml.sax.SAXException

createStartEvents

protected void createStartEvents(org.xml.sax.Attributes attributes,
                     java.util.Collection[] events)

Creates the Namespaceand Attributeevents associated with a StartElement.

Parameters:

attributes - The SAX attributes object.

events - An array used to return the two collections of Namespaceand Attributeevents. The namespaces will be placed at events[0] and the attributes as events[1].

createNamespace

protected javax.xml.stream.events.Namespace createNamespace(java.lang.String prefix,
                                                java.lang.String uri)