net.n3.nanoxml.XMLWriter Maven / Gradle / Ivy

Go to download
/* XMLWriter.java                                                  NanoXML/Java
 *
 * $Revision: 2163 $
 * $Date: 2008-05-18 15:48:36 +0200 (Dim 18 mai 2008) $
 * $Name$
 *
 * This file is part of NanoXML 2 for Java.
 * Copyright (C) 2001 Marc De Scheemaecker, All Rights Reserved.
 *
 * This software is provided 'as-is', without any express or implied warranty.
 * In no event will the authors be held liable for any damages arising from the
 * use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 *  1. The origin of this software must not be misrepresented; you must not
 *     claim that you wrote the original software. If you use this software in
 *     a product, an acknowledgment in the product documentation would be
 *     appreciated but is not required.
 *
 *  2. Altered source versions must be plainly marked as such, and must not be
 *     misrepresented as being the original software.
 *
 *  3. This notice may not be removed or altered from any source distribution.
 */

package net.n3.nanoxml;

import java.io.IOException;
import java.io.OutputStream;
import java.io.PrintWriter;
import java.io.Writer;
import java.util.Enumeration;

/**
 * An XMLWriter writes XML data to a stream.
 *
 * @author Marc De Scheemaecker
 * @version $Name$, $Revision: 2163 $
 * @see net.n3.nanoxml.XMLElement
 * @see java.io.Writer
 */
public class XMLWriter
{

    /**
     * Where to write the output to.
     */
    private PrintWriter writer;

    /**
     * Creates a new XML writer.
     *
     * @param writer where to write the output to.
     */
    public XMLWriter(Writer writer)
    {
        if (writer instanceof PrintWriter)
        {
            this.writer = (PrintWriter) writer;
        }
        else
        {
            this.writer = new PrintWriter(writer);
        }
    }

    /**
     * Creates a new XML writer.
     *
     * @param stream where to write the output to.
     */
    public XMLWriter(OutputStream stream)
    {
        this.writer = new PrintWriter(stream);
    }

    /**
     * Cleans up the object when it's destroyed.
     */
    protected void finalize() throws Throwable
    {
        this.writer = null;
        super.finalize();
    }

    /**
     * Writes an XML element.
     *
     * @param xml the non-null XML element to write.
     */
    public void write(XMLElement xml) throws IOException
    {
        this.write(xml, true, 0);
    }

    /**
     * Writes an XML element.
     *
     * @param xml         the non-null XML element to write.
     * @param prettyPrint if spaces need to be inserted to make the output more readable
     */
    public void write(XMLElement xml, boolean prettyPrint) throws IOException
    {
        this.write(xml, prettyPrint, 0);
    }

    /**
     * Writes an XML element.
     *
     * @param xml         the non-null XML element to write.
     * @param prettyPrint if spaces need to be inserted to make the output more readable
     * @param indent      how many spaces to indent the element.
     */
    public void write(XMLElement xml, boolean prettyPrint, int indent) throws IOException
    {
        if (prettyPrint)
        {
            for (int i = 0; i < indent; i++)
            {
                this.writer.print(' ');
            }
        }

        if (xml.getName() == null)
        {
            if (xml.getContent() != null)
            {
                if (prettyPrint)
                {
                    this.writeEncoded(xml.getContent().trim());
                    writer.println();
                }
                else
                {
                    this.writeEncoded(xml.getContent());
                }
            }
        }
        else
        {
            this.writer.print('<');
            this.writer.print(xml.getName());
            Enumeration enumeration = xml.enumerateAttributeNames();

            while (enumeration.hasMoreElements())
            {
                String key = (String) enumeration.nextElement();
                String value = xml.getAttribute(key);
                this.writer.print(" " + key + "=\"");
                this.writeEncoded(value);
                this.writer.print('"');
            }

            if ((xml.getContent() != null) && (xml.getContent().length() > 0))
            {
                writer.print('>');
                this.writeEncoded(xml.getContent());
                writer.print("');

                if (prettyPrint)
                {
                    writer.println();
                }
            }
            else if (xml.hasChildren())
            {
                writer.print('>');

                if (prettyPrint)
                {
                    writer.println();
                }

                enumeration = xml.enumerateChildren();

                while (enumeration.hasMoreElements())
                {
                    XMLElement child = (XMLElement) enumeration.nextElement();
                    this.write(child, prettyPrint, indent + 4);
                }

                if (prettyPrint)
                {
                    for (int i = 0; i < indent; i++)
                    {
                        this.writer.print(' ');
                    }
                }

                this.writer.print("");

                if (prettyPrint)
                {
                    writer.println();
                }
            }
            else
            {
                this.writer.print("/>");

                if (prettyPrint)
                {
                    writer.println();
                }
            }
        }

        this.writer.flush();
    }

    /**
     * Writes a string encoding reserved characters.
     *
     * @param str the string to write.
     */
    private void writeEncoded(String str)
    {
        for (int i = 0; i < str.length(); i++)
        {
            char c = str.charAt(i);

            switch (c)
            {
                case 0x0D:
                case 0x0A:
                    this.writer.print(c);
                    break;

                case '<':
                    this.writer.print("<");
                    break;

                case '>':
                    this.writer.print(">");
                    break;

                case '&':
                    this.writer.print("&");
                    break;

                case '\'':
                    this.writer.print("'");
                    break;

                case '"':
                    this.writer.print(""");
                    break;

                default:
                    if ((c < ' ') || (c > 0x7E))
                    {
                        this.writer.print("&#x");
                        this.writer.print(Integer.toString(c, 16));
                        this.writer.print(';');
                    }
                    else
                    {
                        this.writer.print(c);
                    }
            }
        }
    }

}