net.anotheria.util.xml.XMLTree Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ano-util Show documentation

There is a newer version: 4.0.0

package net.anotheria.util.xml;

import java.io.IOException;
import java.io.OutputStreamWriter;

/**
 * Represents an XML Dom. Used for export/import data to and from xml.
 *
 * @author lrosenberg
 * @version $Id: $Id
 */
public class XMLTree {
	/**
	 * The version attribute. If not specified 1.0 is assumed.
	 */
	private String version;
	/**
	 * The encoding attribute. If not specified utf-8 is assumed.
	 */
	private String encoding;
	
	/**
	 * The root node.
	 */
	private XMLNode root;
	/**
	 * Creates a new, empty tree.
	 */
	public XMLTree(){
		version = "1.0";
		encoding = "utf-8";
	}

	/**
	 * Returns the root node.
	 *
	 * @return a {@link net.anotheria.util.xml.XMLNode} object.
	 */
	public XMLNode getRoot() {
		return root;
	}

	/**
	 * Setter for the field root.
	 *
	 * @param aRoot a {@link net.anotheria.util.xml.XMLNode} object.
	 */
	public void setRoot(XMLNode aRoot) {
		this.root = aRoot;
	}

	/**
	 * Getter for the field version.
	 *
	 * @return a {@link java.lang.String} object.
	 */
	public String getVersion() {
		return version;
	}

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

	/**
	 * Returns the encoding.
	 *
	 * @return a {@link java.lang.String} object.
	 */
	public String getEncoding() {
		return encoding;
	}

	/**
	 * Sets the encoding.
	 *
	 * @param aEncoding the encoding value.
	 */
	public void setEncoding(String aEncoding) {
		this.encoding = aEncoding;
	}
	
	/**
	 * Writes the contents of the xml tree as xml to the given output writer.
	 *
	 * @param aWriter the writer to write the output to.
	 * @throws java.io.IOException rethrown if thrown by the writer.
	 */
	public void write(OutputStreamWriter aWriter) throws IOException{
		aWriter.write("\n");
		if (root!=null)
			root.write(aWriter, 0);
	}

}