All Downloads are FREE. Search and download functionalities are using the official Maven repository.

javanet.staxutils.io.StreamEventWriter Maven / Gradle / Ivy

/*
 * $Id: StreamEventWriter.java,v 1.4 2004/07/15 02:09:59 cniles Exp $
 * 
 * Copyright (c) 2004, Christian Niles, unit12.net
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 *		*   Redistributions of source code must retain the above copyright
 *          notice, this list of conditions and the following disclaimer.
 * 
 *	    *	Redistributions in binary form must reproduce the above copyright
 *          notice, this list of conditions and the following disclaimer in the
 *          documentation and/or other materials provided with the distribution.
 * 
 *      *   Neither the name of Christian Niles, Unit12, nor the names of its
 *          contributors may be used to endorse or promote products derived from
 *          this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 * 
 */
package javanet.staxutils.io;

import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.io.Writer;

import javanet.staxutils.BaseXMLEventWriter;

import javax.xml.stream.XMLStreamException;
import javax.xml.stream.events.StartElement;
import javax.xml.stream.events.XMLEvent;

/**
 * {@link javax.xml.stream.XMLEventWriter} that writes events to a character stream
 * using {@link XMLEvent#writeAsEncodedUnicode(Writer)}.
 * 
 * @author Christian Niles
 * @version $Revision: 1.4 $
 */
public class StreamEventWriter extends BaseXMLEventWriter {

    /** The underlying {@link Writer}. */
    private Writer writer;

    /**
     * Constructs a new StreamEventWriter that writes to a file.
     * 
     * @param file The file to write.
     * @throws IOException If the file couldn't be opened.
     */
    public StreamEventWriter(File file) throws IOException {

        this(new FileWriter(file));

    }

    /**
     * Constructs a new StreamEventWriter that writes to a binary
     * stream.
     * 
     * @param os The stream to write.
     */
    public StreamEventWriter(OutputStream os) {

        this(new OutputStreamWriter(os));

    }

    /**
     * Constructs a new StreamEventWriter that writes to a character
     * stream.
     * 
     * @param writer The stream to write.
     */
    public StreamEventWriter(Writer writer) {

        this.writer = writer;

    }

    public synchronized void flush() throws XMLStreamException {

        super.flush();
        try {

            writer.flush();

        } catch (IOException e) {

            throw new XMLStreamException(e);

        }

    }

    /**
     * Saved reference to most recent start element. This is used to properly
     * write empty elements. Each startElement event is saved here until the
     * next event is received, at which point it will be written as a start or
     * empty element if it is followed directly by an EndElement.
     */
    private StartElement savedStart;

    protected void sendEvent(XMLEvent event) throws XMLStreamException {

        try {
            
            // Check if we have a cached start tag. If we do, then we should
            // check if this event is actually an end tag, so we can properly
            // write an empty element.
            if (savedStart != null) {

                StartElement start = savedStart;
                savedStart = null;

                if (event.getEventType() == XMLEvent.END_ELEMENT) {

                    // this end tag directly followed a start tag, so send
                    // the underlying writer an empty start element
                    XMLWriterUtils.writeStartElement(start, true, writer);
                    writer.flush();
                    return;

                } else {

                    // element has content, so send a regular start tag
                    XMLWriterUtils.writeStartElement(start, false, writer);

                }

            }

            if (event.isStartElement()) {
                
                savedStart = event.asStartElement();
                
            } else {

                event.writeAsEncodedUnicode(writer);

            }
            
        } catch (IOException e) {

            throw new XMLStreamException(e);

        }

    }

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy