root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Revised XMLEventStreamWriter to allow for empty elements with attributes 

Issue: SPR-11254
This commit is contained in:
Juergen Hoeller 2013-12-23 12:49:47 +01:00
parent 710fdc73f1
commit ee5b7fdab8
1 changed files with 190 additions and 157 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

347
spring-core/src/main/java/org/springframework/util/xml/XMLEventStreamWriter.java
View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2012 the original author or authors. * Copyright 2002-2013 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -19,7 +19,6 @@ package org.springframework.util.xml;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Iterator; import java.util.Iterator;
import java.util.List; import java.util.List;
import javax.xml.namespace.NamespaceContext; import javax.xml.namespace.NamespaceContext;
import javax.xml.namespace.QName; import javax.xml.namespace.QName;
import javax.xml.stream.XMLEventFactory; import javax.xml.stream.XMLEventFactory;
@ -33,13 +32,13 @@ import javax.xml.stream.events.StartElement;
import org.springframework.util.Assert; import org.springframework.util.Assert;
/** /**
* Implementation of the {@link javax.xml.stream.XMLStreamWriter} interface that wraps a {@link XMLEventWriter}. * Implementation of the {@link javax.xml.stream.XMLStreamWriter} interface
* that wraps an {@link XMLEventWriter}.
* *
* @author Arjen Poutsma * @author Arjen Poutsma
* @since 3.0.5 * @since 3.0.5
* @see StaxUtils#createEventStreamWriter(javax.xml.stream.XMLEventWriter, javax.xml.stream.XMLEventFactory) * @see StaxUtils#createEventStreamWriter(javax.xml.stream.XMLEventWriter, javax.xml.stream.XMLEventFactory)
*/ */
@SuppressWarnings("rawtypes")
class XMLEventStreamWriter implements XMLStreamWriter { class XMLEventStreamWriter implements XMLStreamWriter {
private static final String DEFAULT_ENCODING = "UTF-8"; private static final String DEFAULT_ENCODING = "UTF-8";
@ -48,166 +47,42 @@ class XMLEventStreamWriter implements XMLStreamWriter {
private final XMLEventFactory eventFactory; private final XMLEventFactory eventFactory;
private List<EndElement> endElements = new ArrayList<EndElement>(); private final List<EndElement> endElements = new ArrayList<EndElement>();
private boolean emptyElement = false;
public XMLEventStreamWriter(XMLEventWriter eventWriter, XMLEventFactory eventFactory) { public XMLEventStreamWriter(XMLEventWriter eventWriter, XMLEventFactory eventFactory) {
Assert.notNull(eventWriter, "'eventWriter' must not be null"); Assert.notNull(eventWriter, "'eventWriter' must not be null");
Assert.notNull(eventFactory, "'eventFactory' must not be null"); Assert.notNull(eventFactory, "'eventFactory' must not be null");
this.eventWriter = eventWriter; this.eventWriter = eventWriter;
this.eventFactory = eventFactory; this.eventFactory = eventFactory;
} }
@Override @Override
public NamespaceContext getNamespaceContext() { public void setNamespaceContext(NamespaceContext context) throws XMLStreamException {
return eventWriter.getNamespaceContext(); this.eventWriter.setNamespaceContext(context);
} }
@Override @Override
public String getPrefix(String uri) throws XMLStreamException { public NamespaceContext getNamespaceContext() {
return eventWriter.getPrefix(uri); return this.eventWriter.getNamespaceContext();
} }
@Override @Override
public void setPrefix(String prefix, String uri) throws XMLStreamException { public void setPrefix(String prefix, String uri) throws XMLStreamException {
eventWriter.setPrefix(prefix, uri); this.eventWriter.setPrefix(prefix, uri);
}
@Override
public String getPrefix(String uri) throws XMLStreamException {
return this.eventWriter.getPrefix(uri);
} }
@Override @Override
public void setDefaultNamespace(String uri) throws XMLStreamException { public void setDefaultNamespace(String uri) throws XMLStreamException {
eventWriter.setDefaultNamespace(uri); this.eventWriter.setDefaultNamespace(uri);
}
@Override
public void setNamespaceContext(NamespaceContext context) throws XMLStreamException {
eventWriter.setNamespaceContext(context);
}
@Override
public void writeStartDocument() throws XMLStreamException {
eventWriter.add(eventFactory.createStartDocument());
}
@Override
public void writeStartDocument(String version) throws XMLStreamException {
eventWriter.add(eventFactory.createStartDocument(DEFAULT_ENCODING, version));
}
@Override
public void writeStartDocument(String encoding, String version) throws XMLStreamException {
eventWriter.add(eventFactory.createStartDocument(encoding, version));
}
@Override
public void writeStartElement(String localName) throws XMLStreamException {
writeStartElement(eventFactory.createStartElement(new QName(localName), null, null));
}
@Override
public void writeStartElement(String namespaceURI, String localName) throws XMLStreamException {
writeStartElement(eventFactory.createStartElement(new QName(namespaceURI, localName), null, null));
}
@Override
public void writeStartElement(String prefix, String localName, String namespaceURI) throws XMLStreamException {
writeStartElement(eventFactory.createStartElement(new QName(namespaceURI, localName, prefix), null, null));
}
@Override
public void writeEmptyElement(String localName) throws XMLStreamException {
writeStartElement(localName);
writeEndElement();
}
@Override
public void writeEmptyElement(String namespaceURI, String localName) throws XMLStreamException {
writeStartElement(namespaceURI, localName);
writeEndElement();
}
@Override
public void writeEmptyElement(String prefix, String localName, String namespaceURI) throws XMLStreamException {
writeStartElement(prefix, localName, namespaceURI);
writeEndElement();
}
@Override
public void writeEndElement() throws XMLStreamException {
int last = endElements.size() - 1;
EndElement lastEndElement = endElements.get(last);
eventWriter.add(lastEndElement);
endElements.remove(last);
}
@Override
public void writeAttribute(String localName, String value) throws XMLStreamException {
eventWriter.add(eventFactory.createAttribute(localName, value));
}
@Override
public void writeAttribute(String namespaceURI, String localName, String value) throws XMLStreamException {
eventWriter.add(eventFactory.createAttribute(new QName(namespaceURI, localName), value));
}
@Override
public void writeAttribute(String prefix, String namespaceURI, String localName, String value)
throws XMLStreamException {
eventWriter.add(eventFactory.createAttribute(prefix, namespaceURI, localName, value));
}
@Override
public void writeNamespace(String prefix, String namespaceURI) throws XMLStreamException {
writeNamespace(eventFactory.createNamespace(prefix, namespaceURI));
}
@Override
public void writeDefaultNamespace(String namespaceURI) throws XMLStreamException {
writeNamespace(eventFactory.createNamespace(namespaceURI));
}
@Override
public void writeCharacters(String text) throws XMLStreamException {
eventWriter.add(eventFactory.createCharacters(text));
}
@Override
public void writeCharacters(char[] text, int start, int len) throws XMLStreamException {
eventWriter.add(eventFactory.createCharacters(new String(text, start, len)));
}
@Override
public void writeCData(String data) throws XMLStreamException {
eventWriter.add(eventFactory.createCData(data));
}
@Override
public void writeComment(String data) throws XMLStreamException {
eventWriter.add(eventFactory.createComment(data));
}
@Override
public void writeProcessingInstruction(String target) throws XMLStreamException {
eventWriter.add(eventFactory.createProcessingInstruction(target, ""));
}
@Override
public void writeProcessingInstruction(String target, String data) throws XMLStreamException {
eventWriter.add(eventFactory.createProcessingInstruction(target, data));
}
@Override
public void writeDTD(String dtd) throws XMLStreamException {
eventWriter.add(eventFactory.createDTD(dtd));
}
@Override
public void writeEntityRef(String name) throws XMLStreamException {
eventWriter.add(eventFactory.createEntityReference(name, null));
}
@Override
public void writeEndDocument() throws XMLStreamException {
eventWriter.add(eventFactory.createEndDocument());
} }
@Override @Override
@ -215,24 +90,116 @@ class XMLEventStreamWriter implements XMLStreamWriter {
throw new IllegalArgumentException(); throw new IllegalArgumentException();
} }
@Override @Override
public void flush() throws XMLStreamException { public void writeStartDocument() throws XMLStreamException {
eventWriter.flush(); closeEmptyElementIfNecessary();
this.eventWriter.add(this.eventFactory.createStartDocument());
} }
@Override @Override
public void close() throws XMLStreamException { public void writeStartDocument(String version) throws XMLStreamException {
eventWriter.close(); closeEmptyElementIfNecessary();
this.eventWriter.add(this.eventFactory.createStartDocument(DEFAULT_ENCODING, version));
} }
private void writeStartElement(StartElement startElement) throws XMLStreamException { @Override
eventWriter.add(startElement); public void writeStartDocument(String encoding, String version) throws XMLStreamException {
endElements.add(eventFactory.createEndElement(startElement.getName(), startElement.getNamespaces())); closeEmptyElementIfNecessary();
this.eventWriter.add(this.eventFactory.createStartDocument(encoding, version));
} }
private void writeNamespace(Namespace namespace) throws XMLStreamException { @Override
int last = endElements.size() - 1; public void writeStartElement(String localName) throws XMLStreamException {
EndElement oldEndElement = endElements.get(last); closeEmptyElementIfNecessary();
doWriteStartElement(this.eventFactory.createStartElement(new QName(localName), null, null));
}
@Override
public void writeStartElement(String namespaceURI, String localName) throws XMLStreamException {
closeEmptyElementIfNecessary();
doWriteStartElement(this.eventFactory.createStartElement(new QName(namespaceURI, localName), null, null));
}
@Override
public void writeStartElement(String prefix, String localName, String namespaceURI) throws XMLStreamException {
closeEmptyElementIfNecessary();
doWriteStartElement(this.eventFactory.createStartElement(new QName(namespaceURI, localName, prefix), null, null));
}
private void doWriteStartElement(StartElement startElement) throws XMLStreamException {
this.eventWriter.add(startElement);
this.endElements.add(this.eventFactory.createEndElement(startElement.getName(), startElement.getNamespaces()));
}
@Override
public void writeEmptyElement(String localName) throws XMLStreamException {
closeEmptyElementIfNecessary();
writeStartElement(localName);
this.emptyElement = true;
}
@Override
public void writeEmptyElement(String namespaceURI, String localName) throws XMLStreamException {
closeEmptyElementIfNecessary();
writeStartElement(namespaceURI, localName);
this.emptyElement = true;
}
@Override
public void writeEmptyElement(String prefix, String localName, String namespaceURI) throws XMLStreamException {
closeEmptyElementIfNecessary();
writeStartElement(prefix, localName, namespaceURI);
this.emptyElement = true;
}
private void closeEmptyElementIfNecessary() throws XMLStreamException {
if (this.emptyElement) {
this.emptyElement = false;
writeEndElement();
}
}
@Override
public void writeEndElement() throws XMLStreamException {
closeEmptyElementIfNecessary();
int last = this.endElements.size() - 1;
EndElement lastEndElement = this.endElements.get(last);
this.eventWriter.add(lastEndElement);
this.endElements.remove(last);
}
@Override
public void writeAttribute(String localName, String value) throws XMLStreamException {
this.eventWriter.add(this.eventFactory.createAttribute(localName, value));
}
@Override
public void writeAttribute(String namespaceURI, String localName, String value) throws XMLStreamException {
this.eventWriter.add(this.eventFactory.createAttribute(new QName(namespaceURI, localName), value));
}
@Override
public void writeAttribute(String prefix, String namespaceURI, String localName, String value)
throws XMLStreamException {
this.eventWriter.add(this.eventFactory.createAttribute(prefix, namespaceURI, localName, value));
}
@Override
public void writeNamespace(String prefix, String namespaceURI) throws XMLStreamException {
doWriteNamespace(this.eventFactory.createNamespace(prefix, namespaceURI));
}
@Override
public void writeDefaultNamespace(String namespaceURI) throws XMLStreamException {
doWriteNamespace(this.eventFactory.createNamespace(namespaceURI));
}
@SuppressWarnings("rawtypes")
private void doWriteNamespace(Namespace namespace) throws XMLStreamException {
int last = this.endElements.size() - 1;
EndElement oldEndElement = this.endElements.get(last);
Iterator oldNamespaces = oldEndElement.getNamespaces(); Iterator oldNamespaces = oldEndElement.getNamespaces();
List<Namespace> newNamespaces = new ArrayList<Namespace>(); List<Namespace> newNamespaces = new ArrayList<Namespace>();
while (oldNamespaces.hasNext()) { while (oldNamespaces.hasNext()) {
@ -240,8 +207,74 @@ class XMLEventStreamWriter implements XMLStreamWriter {
newNamespaces.add(oldNamespace); newNamespaces.add(oldNamespace);
} }
newNamespaces.add(namespace); newNamespaces.add(namespace);
EndElement newEndElement = eventFactory.createEndElement(oldEndElement.getName(), newNamespaces.iterator()); EndElement newEndElement = this.eventFactory.createEndElement(oldEndElement.getName(), newNamespaces.iterator());
eventWriter.add(namespace); this.eventWriter.add(namespace);
endElements.set(last, newEndElement); this.endElements.set(last, newEndElement);
} }
@Override
public void writeCharacters(String text) throws XMLStreamException {
closeEmptyElementIfNecessary();
this.eventWriter.add(this.eventFactory.createCharacters(text));
}
@Override
public void writeCharacters(char[] text, int start, int len) throws XMLStreamException {
closeEmptyElementIfNecessary();
this.eventWriter.add(this.eventFactory.createCharacters(new String(text, start, len)));
}
@Override
public void writeCData(String data) throws XMLStreamException {
closeEmptyElementIfNecessary();
this.eventWriter.add(this.eventFactory.createCData(data));
}
@Override
public void writeComment(String data) throws XMLStreamException {
closeEmptyElementIfNecessary();
this.eventWriter.add(this.eventFactory.createComment(data));
}
@Override
public void writeProcessingInstruction(String target) throws XMLStreamException {
closeEmptyElementIfNecessary();
this.eventWriter.add(this.eventFactory.createProcessingInstruction(target, ""));
}
@Override
public void writeProcessingInstruction(String target, String data) throws XMLStreamException {
closeEmptyElementIfNecessary();
this.eventWriter.add(this.eventFactory.createProcessingInstruction(target, data));
}
@Override
public void writeDTD(String dtd) throws XMLStreamException {
closeEmptyElementIfNecessary();
this.eventWriter.add(this.eventFactory.createDTD(dtd));
}
@Override
public void writeEntityRef(String name) throws XMLStreamException {
closeEmptyElementIfNecessary();
this.eventWriter.add(this.eventFactory.createEntityReference(name, null));
}
@Override
public void writeEndDocument() throws XMLStreamException {
closeEmptyElementIfNecessary();
this.eventWriter.add(this.eventFactory.createEndDocument());
}
@Override
public void flush() throws XMLStreamException {
this.eventWriter.flush();
}
@Override
public void close() throws XMLStreamException {
closeEmptyElementIfNecessary();
this.eventWriter.close();
}
} }