/*
* XMLWriter.java NanoXML/Java $Revision: 1.4 $ $Date: 2002/03/24 11:37:51 $
* $Name: RELEASE_2_2_1 $ This file is part of NanoXML 2 for Java. Copyright (C)
* 2000-2002 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 org.freeplane.n3.nanoxml;
import java.io.IOException;
import java.io.OutputStream;
import java.io.PrintWriter;
import java.io.Writer;
import java.util.Enumeration;
import java.util.Vector;
/**
* An XMLWriter writes XML data to a stream.
*
* @see org.freeplane.n3.nanoxml.XMLElement
* @see java.io.Writer
* @author Marc De Scheemaecker
* @version $Name: RELEASE_2_2_1 $, $Revision: 1.4 $
*/
public class XMLWriter {
/**
* Where to write the output to.
*/
private PrintWriter writer;
private boolean inContent = false;
/**
* Creates a new XML writer.
*
* @param stream
* where to write the output to.
*/
public XMLWriter(final OutputStream stream) {
writer = new PrintWriter(stream);
}
/**
* Creates a new XML writer.
*
* @param writer
* where to write the output to.
*/
public XMLWriter(final Writer writer) {
if (writer instanceof PrintWriter) {
this.writer = (PrintWriter) writer;
}
else {
this.writer = new PrintWriter(writer);
}
}
/**
* Cleans up the object when it's destroyed.
*/
@Override
protected void finalize() throws Throwable {
writer = null;
super.finalize();
}
/**
* Writes an XML element.
*
* @param xml
* the non-null XML element to write.
*/
public void write(final XMLElement xml) throws IOException {
this.write(xml, false, 0, true);
}
/**
* 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(final XMLElement xml, final boolean prettyPrint) throws IOException {
this.write(xml, prettyPrint, 0, true);
}
/**
* 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(final XMLElement xml, final boolean prettyPrint, final int indent) throws IOException {
this.write(xml, prettyPrint, indent, true);
}
/**
* 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(final XMLElement xml, final boolean prettyPrint, final int indent,
final boolean collapseEmptyElements) throws IOException {
if (prettyPrint) {
for (int i = 0; i < indent; i++) {
writer.print(' ');
}
}
if (xml.getName() == null) {
if (xml.getContent() != null) {
if (prettyPrint) {
this.writeEncodedContent(xml.getContent().trim());
writer.println();
}
else {
this.writeEncodedContent(xml.getContent());
}
}
}
else {
writer.print('<');
writer.print(xml.getFullName());
final Vector<String> nsprefixes = new Vector<String>();
if (xml.getNamespace() != null) {
if (xml.getName().equals(xml.getFullName())) {
writer.print(" xmlns=\"" + xml.getNamespace() + '"');
}
else {
String prefix = xml.getFullName();
prefix = prefix.substring(0, prefix.indexOf(':'));
nsprefixes.addElement(prefix);
writer.print(" xmlns:" + prefix);
writer.print("=\"" + xml.getNamespace() + "\"");
}
}
Enumeration<String> enumAttributeNames = xml.enumerateAttributeNames();
while (enumAttributeNames.hasMoreElements()) {
final String key = enumAttributeNames.nextElement();
final int index = key.indexOf(':');
if (index >= 0) {
final String namespace = xml.getAttributeNamespace(key);
if (namespace != null) {
final String prefix = key.substring(0, index);
if (!nsprefixes.contains(prefix)) {
writer.print(" xmlns:" + prefix);
writer.print("=\"" + namespace + '"');
nsprefixes.addElement(prefix);
}
}
}
}
enumAttributeNames = xml.enumerateAttributeNames();
while (enumAttributeNames.hasMoreElements()) {
final String key = enumAttributeNames.nextElement();
final String value = xml.getAttribute(key, null);
writer.print(" " + key + "=\"");
this.writeEncoded(value);
writer.print('"');
}
if ((xml.getContent() != null) && (xml.getContent().length() > 0)) {
writer.print('>');
this.writeEncodedContent(xml.getContent());
writer.print("</" + xml.getFullName() + '>');
if (prettyPrint) {
writer.println();
}
}
else if (xml.hasChildren() || (!collapseEmptyElements)) {
writer.print('>');
if (prettyPrint) {
writer.println();
}
Enumeration<XMLElement> children = xml.enumerateChildren();
while (children.hasMoreElements()) {
final XMLElement child = children.nextElement();
this.write(child, prettyPrint, indent + 4, collapseEmptyElements);
}
if (prettyPrint) {
for (int i = 0; i < indent; i++) {
writer.print(' ');
}
}
writer.print("</" + xml.getFullName() + ">");
if (prettyPrint) {
writer.println();
}
}
else {
writer.print("/>");
if (prettyPrint) {
writer.println();
}
}
}
writer.flush();
}
public void addRawContent(final String comment) {
writer.write(comment);
}
/**
* Writes a string encoding reserved characters.
*
* @param str
* the string to write.
*/
protected void writeEncoded(final String str) {
for (int i = 0; i < str.length(); i++) {
final char c = str.charAt(i);
switch (c) {
case '<':
writer.print("<");
break;
case '>':
writer.print(">");
break;
case '&':
writer.print("&");
break;
case '\'':
writer.print("'");
break;
case '"':
writer.print(""");
break;
case 0x0A:
if(inContent){
writer.print(c);
break;
}
default:
if ((c < ' ') || (c > 0x7E)) {
writer.print("&#x");
writer.print(Integer.toString(c, 16));
writer.print(';');
}
else {
writer.print(c);
}
}
}
}
/**
* Writes a string as encoded content string.
*
* @param str
* the string to write.
*/
protected void writeEncodedContent(final String str) {
inContent = true;
writeEncoded(str);
inContent = false;
}
public PrintWriter getWriter() {
return writer;
}
}