tiled.io.xml.XMLWriter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of libtiled Show documentation
A small Java library to load Tiled maps.
There is a newer version: 1.4.2
/*-
 * #%L
 * This file is part of libtiled-java.
 * %%
 * Copyright (C) 2004 - 2016 Thorbjørn Lindeijer 
 * Copyright (C) 2004 - 2016 Adam Turk 
 * %%
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. 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.
 * 
 * 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 HOLDERS 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.
 * #L%
 */
package tiled.io.xml;

import java.io.Writer;
import java.io.IOException;
import java.util.Stack;

/**
 * A simple helper class to write an XML file, based on
 * http://www.xmlsoft.org/html/libxml-xmlwriter.html
 *
 * @author Thorbjørn Lindeijer
 * @author Adam Turk
 * @version 0.17
 */
public class XMLWriter {

    private boolean bIndent = true;
    private String indentString = " ";
    private String newLine = "\n";
    private final Writer w;

    private final Stack openElements;
    private boolean bStartTagOpen;
    private boolean bDocumentOpen;

    /**
     * Constructor for XMLWriter.
     *
     * @param writer a {@link java.io.Writer} object.
     */
    public XMLWriter(Writer writer) {
        openElements = new Stack<>();
        w = writer;
    }

    /**
     * setIndent.
     *
     * @param bIndent a boolean.
     */
    public void setIndent(boolean bIndent) {
        this.bIndent = bIndent;
        newLine = bIndent ? "\n" : "";
    }

    /**
     * Setter for the field indentString.
     *
     * @param indentString a {@link java.lang.String} object.
     */
    public void setIndentString(String indentString) {
        this.indentString = indentString;
    }

    /**
     * startDocument.
     *
     * @throws java.io.IOException if any.
     */
    public void startDocument() throws IOException {
        startDocument("1.0");
    }

    /**
     * startDocument.
     *
     * @param version a {@link java.lang.String} object.
     * @throws java.io.IOException if any.
     */
    public void startDocument(String version) throws IOException {
        w.write(""
                + newLine);
        bDocumentOpen = true;
    }

    /**
     * writeDocType.
     *
     * @param name a {@link java.lang.String} object.
     * @param pubId a {@link java.lang.String} object.
     * @param sysId a {@link java.lang.String} object.
     * @throws java.io.IOException if any.
     * @throws tiled.io.xml.XMLWriterException if any.
     */
    public void writeDocType(String name, String pubId, String sysId)
            throws IOException, XMLWriterException {
        if (!bDocumentOpen) {
            throw new XMLWriterException(
                    "Can't write DocType, no open document.");
        } else if (!openElements.isEmpty()) {
            throw new XMLWriterException(
                    "Can't write DocType, open elements exist.");
        }

        w.write("" + newLine);
    }

    /**
     * startElement.
     *
     * @param name a {@link java.lang.String} object.
     * @throws java.io.IOException if any.
     * @throws tiled.io.xml.XMLWriterException if any.
     */
    public void startElement(String name)
            throws IOException, XMLWriterException {
        if (!bDocumentOpen) {
            throw new XMLWriterException(
                    "Can't start new element, no open document.");
        }

        if (bStartTagOpen) {
            w.write(">" + newLine);
        }

        writeIndent();
        w.write("<" + name);

        openElements.push(name);
        bStartTagOpen = true;
    }

    /**
     * endDocument.
     *
     * @throws java.io.IOException if any.
     */
    public void endDocument() throws IOException {
        // End all open elements.
        while (!openElements.isEmpty()) {
            endElement();
        }

        w.flush(); //writers do not always flush automatically...
    }

    /**
     * endElement.
     *
     * @throws java.io.IOException if any.
     */
    public void endElement() throws IOException {
        String name = openElements.pop();

        // If start tag still open, end with />, else with .
        if (bStartTagOpen) {
            w.write("/>" + newLine);
            bStartTagOpen = false;
        } else {
            writeIndent();
            w.write("" + newLine);
        }

        // Set document closed when last element is closed
        if (openElements.isEmpty()) {
            bDocumentOpen = false;
        }
    }

    /**
     * writeAttribute.
     *
     * @param name a {@link java.lang.String} object.
     * @param content a {@link java.lang.String} object.
     * @throws java.io.IOException if any.
     * @throws tiled.io.xml.XMLWriterException if any.
     */
    public void writeAttribute(String name, String content)
            throws IOException, XMLWriterException {
        if (bStartTagOpen) {
            String escapedContent = (content != null)
                    ? content.replaceAll("\"", """) : "";
            w.write(" " + name + "=\"" + escapedContent + "\"");
        } else {
            throw new XMLWriterException(
                    "Can't write attribute without open start tag.");
        }
    }

    /**
     * writeAttribute.
     *
     * @param name a {@link java.lang.String} object.
     * @param content a int.
     * @throws java.io.IOException if any.
     * @throws tiled.io.xml.XMLWriterException if any.
     */
    public void writeAttribute(String name, int content)
            throws IOException, XMLWriterException {
        writeAttribute(name, String.valueOf(content));
    }

    /**
     * writeAttribute.
     *
     * @param name a {@link java.lang.String} object.
     * @param content a float.
     * @throws java.io.IOException if any.
     * @throws tiled.io.xml.XMLWriterException if any.
     */
    public void writeAttribute(String name, float content)
            throws IOException, XMLWriterException {
        writeAttribute(name, String.valueOf(content));
    }

    /**
     * writeAttribute.
     *
     * @param name a {@link java.lang.String} object.
     * @param content a double.
     * @throws java.io.IOException if any.
     * @throws tiled.io.xml.XMLWriterException if any.
     */
    public void writeAttribute(String name, double content)
            throws IOException, XMLWriterException {
        writeAttribute(name, String.valueOf(content));
    }

    /**
     * writeCDATA.
     *
     * @param content a {@link java.lang.String} object.
     * @throws java.io.IOException if any.
     */
    public void writeCDATA(String content) throws IOException {
        if (bStartTagOpen) {
            w.write(">" + newLine);
            bStartTagOpen = false;
        }

        writeIndent();
        w.write(content + newLine);
    }

    /**
     * writeComment.
     *
     * @param content a {@link java.lang.String} object.
     * @throws java.io.IOException if any.
     */
    public void writeComment(String content) throws IOException {
        if (bStartTagOpen) {
            w.write(">" + newLine);
            bStartTagOpen = false;
        }

        writeIndent();
        w.write("" + newLine);
    }

    /**
     * writeElement.
     *
     * @param name a {@link java.lang.String} object.
     * @param content a {@link java.lang.String} object.
     * @throws java.io.IOException if any.
     * @throws tiled.io.xml.XMLWriterException if any.
     */
    public void writeElement(String name, String content)
            throws IOException, XMLWriterException {
        startElement(name);
        writeCDATA(content);
        endElement();
    }

    private void writeIndent() throws IOException {
        if (bIndent) {
            for (String openElement : openElements) {
                w.write(indentString);
            }
        }
    }
}