com.augmentum.common.util.XMLFormatter.java Source code

Introduction

Here is the source code for com.augmentum.common.util.XMLFormatter.java

Source

/**
 * Copyright (c) 2000-2008 Liferay, Inc. All rights reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package com.augmentum.common.util;

import java.io.IOException;
import java.io.StringReader;

import org.dom4j.Branch;
import org.dom4j.Document;
import org.dom4j.DocumentException;
import org.dom4j.io.OutputFormat;
import org.dom4j.io.SAXReader;
import org.dom4j.io.XMLWriter;

/**
 * <a href="XMLFormatter.java.html"><b><i>View Source</i></b></a>
 *
 * @author Brian Wing Shun Chan
 * @author Alan Zimmerman
 *
 */
public class XMLFormatter {

    public static final String INDENT = "\t";

    public static String fixProlog(String xml) {

        // LEP-1921

        if (xml != null) {
            char[] charArray = xml.toCharArray();

            for (int i = 0; i < charArray.length; i++) {
                if (charArray[i] == '<') {
                    if (i != 0) {
                        xml = xml.substring(i, xml.length());
                    }

                    break;
                }
            }
        }

        return xml;
    }

    public static String fromCompactSafe(String xml) {
        return StringUtil.replace(xml, "[$NEW_LINE$]", "\n");
    }

    public static String toCompactSafe(String xml) {
        return StringUtil.replace(xml, "\n", "[$NEW_LINE$]");
    }

    public static String toString(String xml) throws DocumentException, IOException {

        return toString(xml, INDENT);
    }

    public static String toString(String xml, String indent) throws DocumentException, IOException {

        SAXReader reader = new SAXReader();

        Document doc = reader.read(new StringReader(xml));

        return toString(doc, indent);
    }

    public static String toString(Branch branch) throws IOException {
        return toString(branch, INDENT);
    }

    public static String toString(Branch branch, String indent) throws IOException {

        return toString(branch, INDENT, false);
    }

    public static String toString(Branch branch, String indent, boolean expandEmptyElements) throws IOException {

        ByteArrayMaker bam = new ByteArrayMaker();

        OutputFormat format = OutputFormat.createPrettyPrint();

        format.setExpandEmptyElements(expandEmptyElements);
        format.setIndent(indent);
        format.setLineSeparator("\n");

        XMLWriter writer = new XMLWriter(bam, format);

        writer.write(branch);

        String content = bam.toString(StringPool.UTF8);

        // LEP-4257

        //content = StringUtil.replace(content, "\n\n\n", "\n\n");

        if (content.endsWith("\n\n")) {
            content = content.substring(0, content.length() - 2);
        }

        if (content.endsWith("\n")) {
            content = content.substring(0, content.length() - 1);
        }

        while (content.indexOf(" \n") != -1) {
            content = StringUtil.replace(content, " \n", "\n");
        }

        return content;
    }

}