net.erdfelt.maven.xmlfresh.XmlFormatter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xmlfresh-maven-plugin Show documentation

Simple XML tidy/cleanup/freshen utility for maven builds

There is a newer version: 2.3

Show newest version

package net.erdfelt.maven.xmlfresh;

import java.io.File;
import java.io.FileOutputStream;
import java.io.FileReader;
import java.io.IOException;
import java.io.OutputStream;
import java.util.Properties;

import javax.xml.parsers.ParserConfigurationException;

import org.apache.maven.plugin.MojoFailureException;
import org.w3c.dom.Document;
import org.w3c.tidy.Tidy;
import org.xml.sax.SAXException;

import net.erdfelt.maven.xmlfresh.io.IO;

public class XmlFormatter
{
    private Tidy tidy;

    public XmlFormatter()
    {
        tidy = new Tidy();
        // Properties can be found at http://tidy.sourceforge.net/docs/quickref.html
        Properties props = new Properties();
        props.setProperty("output-xml","true");
        props.setProperty("input-xml","true");
        props.setProperty("add-xml-space","false");
        props.setProperty("add-xml-decl","true");

        props.setProperty("wrap","120");
        props.setProperty("indent","true");
        props.setProperty("indent-spaces","2");

        // Not present in jtidy (yet)
        // props.setProperty("sort-attributes","true");
        // props.setProperty("hide-end-tags","false");

        tidy.setConfigurationFromProps(props);

        // Make output quiet
        tidy.setOnlyErrors(true);
        tidy.setQuiet(true);

        // TODO configure tidy here
    }

    /**
     * Read xml file using JTidy
     */
    public Document read(File xmlFile) throws IOException, ParserConfigurationException, SAXException
    {
        FileReader reader = null;
        try
        {
            reader = new FileReader(xmlFile);
            return tidy.parseDOM(reader,null);
        }
        finally
        {
            IO.close(reader);
        }
    }

    public void writePretty(File xmlFile, Document doc) throws IOException
    {
        FileOutputStream out = null;
        try
        {
            System.out.printf("Writing XML: %s%n",xmlFile);
            out = new FileOutputStream(xmlFile,false);
            writePretty(out,doc);
        }
        finally
        {
            IO.close(out);
        }
    }

    public void writePretty(OutputStream out, Document doc) throws IOException
    {
        tidy.pprint(doc,out);
    }

    public void format(File file) throws MojoFailureException
    {
        try
        {
            Document doc = read(file);
            writePretty(file,doc);
        }
        catch (Throwable t)
        {
            throw new MojoFailureException("Failed to format XML: " + file,t);
        }
    }
}