org.springframework.util.xml

Class AbstractStaxHandler

java.lang.Object

org.springframework.util.xml.AbstractStaxHandler

All Implemented Interfaces:

org.xml.sax.ContentHandler, org.xml.sax.ext.LexicalHandler

Direct Known Subclasses:

StaxEventHandler, StaxStreamHandler

abstract class AbstractStaxHandler
extends java.lang.Object
implements org.xml.sax.ContentHandler, org.xml.sax.ext.LexicalHandler

Abstract base class for SAX ContentHandler and LexicalHandler implementations that use StAX as a basis. All methods delegate to internal template methods, capable of throwing a XMLStreamException. Additionally, an namespace context stack is used to keep track of declared namespaces.

Since:

4.0.3

Author:

Arjen Poutsma

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	inCData
private java.util.List<java.util.Map<java.lang.String,java.lang.String>>	namespaceMappings

Constructor Summary

Constructors

Constructor and Description
AbstractStaxHandler()

Method Summary

Modifier and Type	Method and Description
protected abstract void	cDataInternal(java.lang.String data)
void	characters(char[] ch, int start, int length)
protected abstract void	charactersInternal(java.lang.String data)
void	comment(char[] ch, int start, int length)
protected abstract void	commentInternal(java.lang.String comment)
private java.util.Map<java.lang.String,java.lang.String>	currentNamespaceMapping()
protected abstract void	dtdInternal(java.lang.String dtd)
void	endCDATA()
void	endDocument()
protected abstract void	endDocumentInternal()
void	endDTD()
void	endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName)
protected abstract void	endElementInternal(javax.xml.namespace.QName name, java.util.Map<java.lang.String,java.lang.String> namespaceMapping)
void	endEntity(java.lang.String name)
void	endPrefixMapping(java.lang.String prefix)
void	ignorableWhitespace(char[] ch, int start, int length)
protected abstract void	ignorableWhitespaceInternal(java.lang.String data)
protected boolean	isNamespaceDeclaration(javax.xml.namespace.QName qName)
private void	newNamespaceMapping()
void	processingInstruction(java.lang.String target, java.lang.String data)
protected abstract void	processingInstructionInternal(java.lang.String target, java.lang.String data)
private void	removeAllNamespaceMappings()
private void	removeNamespaceMapping()
void	skippedEntity(java.lang.String name)
protected abstract void	skippedEntityInternal(java.lang.String name)
void	startCDATA()
void	startDocument()
protected abstract void	startDocumentInternal()
void	startDTD(java.lang.String name, java.lang.String publicId, java.lang.String systemId)
void	startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes atts)
protected abstract void	startElementInternal(javax.xml.namespace.QName name, org.xml.sax.Attributes attributes, java.util.Map<java.lang.String,java.lang.String> namespaceMapping)
void	startEntity(java.lang.String name)
void	startPrefixMapping(java.lang.String prefix, java.lang.String uri)
protected javax.xml.namespace.QName	toQName(java.lang.String namespaceUri, java.lang.String qualifiedName) Convert a namespace URI and DOM or SAX qualified name to a QName.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xml.sax.ContentHandler

setDocumentLocator

Field Detail

namespaceMappings

private final java.util.List<java.util.Map<java.lang.String,java.lang.String>> namespaceMappings

inCData

private boolean inCData

Constructor Detail

AbstractStaxHandler

AbstractStaxHandler()

Method Detail

startDocument

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

Specified by:

startDocument in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

endDocument

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

Specified by:

endDocument in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

startPrefixMapping

public final void startPrefixMapping(java.lang.String prefix,
                                     java.lang.String uri)

Specified by:

startPrefixMapping in interface org.xml.sax.ContentHandler

endPrefixMapping

public final void endPrefixMapping(java.lang.String prefix)

Specified by:

endPrefixMapping in interface org.xml.sax.ContentHandler

startElement

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

Specified by:

startElement in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

endElement

public final 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

Throws:

org.xml.sax.SAXException

characters

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

Specified by:

characters in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

ignorableWhitespace

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

Specified by:

ignorableWhitespace in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

processingInstruction

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

Specified by:

processingInstruction in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

skippedEntity

public final void skippedEntity(java.lang.String name)
                         throws org.xml.sax.SAXException

Specified by:

skippedEntity in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

startDTD

public final void startDTD(java.lang.String name,
                           java.lang.String publicId,
                           java.lang.String systemId)
                    throws org.xml.sax.SAXException

Specified by:

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

Throws:

org.xml.sax.SAXException

endDTD

public final void endDTD()
                  throws org.xml.sax.SAXException

Specified by:

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

Throws:

org.xml.sax.SAXException

startCDATA

public final void startCDATA()
                      throws org.xml.sax.SAXException

Specified by:

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

Throws:

org.xml.sax.SAXException

endCDATA

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

Specified by:

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

Throws:

org.xml.sax.SAXException

comment

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

Specified by:

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

Throws:

org.xml.sax.SAXException

startEntity

public void startEntity(java.lang.String name)
                 throws org.xml.sax.SAXException

Specified by:

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

Throws:

org.xml.sax.SAXException

endEntity

public void endEntity(java.lang.String name)
               throws org.xml.sax.SAXException

Specified by:

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

Throws:

org.xml.sax.SAXException

toQName

protected javax.xml.namespace.QName toQName(java.lang.String namespaceUri,
                                            java.lang.String qualifiedName)

Convert a namespace URI and DOM or SAX qualified name to a QName. The qualified name can have the form prefix:localname or localName.

Parameters:

namespaceUri - the namespace URI

qualifiedName - the qualified name

Returns:

a QName

isNamespaceDeclaration

protected boolean isNamespaceDeclaration(javax.xml.namespace.QName qName)

currentNamespaceMapping

private java.util.Map<java.lang.String,java.lang.String> currentNamespaceMapping()

newNamespaceMapping

private void newNamespaceMapping()

removeNamespaceMapping

private void removeNamespaceMapping()

removeAllNamespaceMappings

private void removeAllNamespaceMappings()

startDocumentInternal

protected abstract void startDocumentInternal()
                                       throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

endDocumentInternal

protected abstract void endDocumentInternal()
                                     throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

startElementInternal

protected abstract void startElementInternal(javax.xml.namespace.QName name,
                                             org.xml.sax.Attributes attributes,
                                             java.util.Map<java.lang.String,java.lang.String> namespaceMapping)
                                      throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

endElementInternal

protected abstract void endElementInternal(javax.xml.namespace.QName name,
                                           java.util.Map<java.lang.String,java.lang.String> namespaceMapping)
                                    throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

charactersInternal

protected abstract void charactersInternal(java.lang.String data)
                                    throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

cDataInternal

protected abstract void cDataInternal(java.lang.String data)
                               throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

ignorableWhitespaceInternal

protected abstract void ignorableWhitespaceInternal(java.lang.String data)
                                             throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

processingInstructionInternal

protected abstract void processingInstructionInternal(java.lang.String target,
                                                      java.lang.String data)
                                               throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

skippedEntityInternal

protected abstract void skippedEntityInternal(java.lang.String name)
                                       throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

dtdInternal

protected abstract void dtdInternal(java.lang.String dtd)
                             throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

commentInternal

protected abstract void commentInternal(java.lang.String comment)
                                 throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException