com.googlecode.jslint4java.ant.XmlResultFormatter Maven / Gradle / Ivy

Go to download
package com.googlecode.jslint4java.ant;

import java.io.BufferedWriter;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.io.Writer;

import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.util.FileUtils;

import com.googlecode.jslint4java.JSLintResult;
import com.googlecode.jslint4java.formatter.JSLintResultFormatter;
import com.googlecode.jslint4java.formatter.JSLintXmlFormatter;

/**
 * Write out JSLint problems to an XML file. This may be easily transformed into a nice report.
 * Sample output:
 *
 *  *  <jslint>
 *    <file name="bad.js">
 *      <issue line="0" char="0" reason="Insufficient Llamas" evidence="var sheep;"/>
 *    </file>
 *    <file name="good.js"/>
 *  </jslint>
 * 
 *
 * @author dom
 */
public class XmlResultFormatter implements ResultFormatter {

    private final JSLintResultFormatter form;
    private final StringBuilder sb = new StringBuilder();
    private OutputStream out;

    public XmlResultFormatter() {
        form = createFormatter();
    }

    /** Create and return the {@link JSLintResultFormatter} used by this ant result formatter. */
    protected JSLintResultFormatter createFormatter() {
        return new JSLintXmlFormatter();
    }

    public void begin() {
        if (out == null)
            throw new BuildException("must specify destFile for xml output");
        // Clear, just in case this object gets reused.
        if (sb.length() > 0) {
            sb.delete(0, sb.length() - 1);
        }
        if (form.header() != null) {
            sb.append(form.header());
        }
    }

    /**
     * Write out the XML file containing the issues for all files.
     *
     * @see com.googlecode.jslint4java.ant.ResultFormatter#end()
     */
    public void end() {
        if (form.footer() != null) {
            sb.append(form.footer());
        }
        Writer w = null;
        try {
            w = new BufferedWriter(new OutputStreamWriter(out, "UTF8"));
            w.write(sb.toString());
            w.flush();
        } catch (IOException exc) {
            throw new BuildException("Unable to write log file", exc);
        } finally {
            FileUtils.close(w);
        }
        out = null;
    }

    /**
     * Create a "file" element, containing nested "issue" elements. Each issue will have
     * line, char, reason and evidence attributes. An element will be
     * created for all files, regardless of any issues being uncovered.
     */
    public void output(JSLintResult result) {
        sb.append(form.format(result));
    }

    public void setFile(File file) {
        try {
            out = new FileOutputStream(file);
        } catch (FileNotFoundException e) {
            throw new BuildException(e);
        }
    }

    public void setStdout(OutputStream defaultOutputStream) {
        // Ignore, we never want to write to stdout.
    }

}