Open Source Repository

Home /spring/spring-core-3.0.5 | Repository Home



org/springframework/util/xml/XMLEventStreamWriter.java
/*
 * Copyright 2002-2010 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.util.xml;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import javax.xml.namespace.NamespaceContext;
import javax.xml.namespace.QName;
import javax.xml.stream.XMLEventFactory;
import javax.xml.stream.XMLEventWriter;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamWriter;
import javax.xml.stream.events.EndElement;
import javax.xml.stream.events.Namespace;
import javax.xml.stream.events.StartElement;

import org.springframework.util.Assert;

/**
 * Implementation of the {@link javax.xml.stream.XMLStreamWriter} interface that wraps a {@link XMLEventWriter}.
 *
 @author Arjen Poutsma
 @since 3.0.5
 @see StaxUtils#createEventStreamWriter(javax.xml.stream.XMLEventWriter, javax.xml.stream.XMLEventFactory) 
 */
class XMLEventStreamWriter implements XMLStreamWriter {

  private static final String DEFAULT_ENCODING = "UTF-8";

  private final XMLEventWriter eventWriter;

  private final XMLEventFactory eventFactory;

  private List<EndElement> endElements = new ArrayList<EndElement>();

  public XMLEventStreamWriter(XMLEventWriter eventWriter, XMLEventFactory eventFactory) {
    Assert.notNull(eventWriter, "'eventWriter' must not be null");
    Assert.notNull(eventFactory, "'eventFactory' must not be null");
    
    this.eventWriter = eventWriter;
    this.eventFactory = eventFactory;
  }

  public NamespaceContext getNamespaceContext() {
    return eventWriter.getNamespaceContext();
  }

  public String getPrefix(String urithrows XMLStreamException {
    return eventWriter.getPrefix(uri);
  }

  public void setPrefix(String prefix, String urithrows XMLStreamException {
    eventWriter.setPrefix(prefix, uri);
  }

  public void setDefaultNamespace(String urithrows XMLStreamException {
    eventWriter.setDefaultNamespace(uri);
  }

  public void setNamespaceContext(NamespaceContext contextthrows XMLStreamException {
    eventWriter.setNamespaceContext(context);
  }

  public void writeStartDocument() throws XMLStreamException {
    eventWriter.add(eventFactory.createStartDocument());
  }

  public void writeStartDocument(String versionthrows XMLStreamException {
    eventWriter.add(eventFactory.createStartDocument(DEFAULT_ENCODING, version));
  }

  public void writeStartDocument(String encoding, String versionthrows XMLStreamException {
    eventWriter.add(eventFactory.createStartDocument(encoding, version));
  }

  public void writeStartElement(String localNamethrows XMLStreamException {
    writeStartElement(eventFactory.createStartElement(new QName(localName), null, null));
  }

  public void writeStartElement(String namespaceURI, String localNamethrows XMLStreamException {
    writeStartElement(eventFactory.createStartElement(new QName(namespaceURI, localName), null, null));
  }

  public void writeStartElement(String prefix, String localName, String namespaceURIthrows XMLStreamException {
    writeStartElement(eventFactory.createStartElement(new QName(namespaceURI, localName, prefix), null, null));
  }

  public void writeEmptyElement(String localNamethrows XMLStreamException {
    writeStartElement(localName);
    writeEndElement();
  }

  public void writeEmptyElement(String namespaceURI, String localNamethrows XMLStreamException {
    writeStartElement(namespaceURI, localName);
    writeEndElement();
  }

  public void writeEmptyElement(String prefix, String localName, String namespaceURIthrows XMLStreamException {
    writeStartElement(prefix, localName, namespaceURI);
    writeEndElement();
  }

  public void writeEndElement() throws XMLStreamException {
    int last = endElements.size() 1;
    EndElement lastEndElement = endElements.get(last);
    eventWriter.add(lastEndElement);
    endElements.remove(last);
  }

  public void writeAttribute(String localName, String valuethrows XMLStreamException {
    eventWriter.add(eventFactory.createAttribute(localName, value));
  }

  public void writeAttribute(String namespaceURI, String localName, String valuethrows XMLStreamException {
    eventWriter.add(eventFactory.createAttribute(new QName(namespaceURI, localName), value));
  }

  public void writeAttribute(String prefix, String namespaceURI, String localName, String value)
      throws XMLStreamException {
    eventWriter.add(eventFactory.createAttribute(prefix, namespaceURI, localName, value));
  }

  public void writeNamespace(String prefix, String namespaceURIthrows XMLStreamException {
    writeNamespace(eventFactory.createNamespace(prefix, namespaceURI));
  }

  public void writeDefaultNamespace(String namespaceURIthrows XMLStreamException {
    writeNamespace(eventFactory.createNamespace(namespaceURI));
  }

  public void writeCharacters(String textthrows XMLStreamException {
    eventWriter.add(eventFactory.createCharacters(text));
  }

  public void writeCharacters(char[] text, int start, int lenthrows XMLStreamException {
    eventWriter.add(eventFactory.createCharacters(new String(text, start, len)));
  }

  public void writeCData(String datathrows XMLStreamException {
    eventWriter.add(eventFactory.createCData(data));
  }

  public void writeComment(String datathrows XMLStreamException {
    eventWriter.add(eventFactory.createComment(data));
  }

  public void writeProcessingInstruction(String targetthrows XMLStreamException {
    eventWriter.add(eventFactory.createProcessingInstruction(target, ""));
  }

  public void writeProcessingInstruction(String target, String datathrows XMLStreamException {
    eventWriter.add(eventFactory.createProcessingInstruction(target, data));
  }

  public void writeDTD(String dtdthrows XMLStreamException {
    eventWriter.add(eventFactory.createDTD(dtd));
  }

  public void writeEntityRef(String namethrows XMLStreamException {
    eventWriter.add(eventFactory.createEntityReference(name, null));
  }

  public void writeEndDocument() throws XMLStreamException {
    eventWriter.add(eventFactory.createEndDocument());
  }

  public Object getProperty(String namethrows IllegalArgumentException {
    throw new IllegalArgumentException();
  }

  public void flush() throws XMLStreamException {
    eventWriter.flush();
  }

  public void close() throws XMLStreamException {
    eventWriter.close();
  }

  private void writeStartElement(StartElement startElementthrows XMLStreamException {
    eventWriter.add(startElement);
    endElements.add(eventFactory.createEndElement(startElement.getName()null));
  }

  private void writeNamespace(Namespace namespacethrows XMLStreamException {
    int last = endElements.size() 1;
    EndElement oldEndElement = endElements.get(last);
    Iterator oldNamespaces = oldEndElement.getNamespaces();
    List<Namespace> newNamespaces = new ArrayList<Namespace>();
    while (oldNamespaces.hasNext()) {
      Namespace oldNamespace = (NamespaceoldNamespaces.next();
      newNamespaces.add(oldNamespace);
    }
    newNamespaces.add(namespace);
    EndElement newEndElement = eventFactory.createEndElement(oldEndElement.getName(), newNamespaces.iterator());
    eventWriter.add(namespace);
    endElements.set(last, newEndElement);
  }
}