org.codenarc.report.ReportWriterFactory.groovy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of CodeNarc Show documentation

The CodeNarc project provides a static analysis tool for Groovy code.

There is a newer version: 3.5.0-groovy-4.0

/*
 * Copyright 2010 the original author or authors.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.codenarc.report

import org.codenarc.util.PropertyUtil

/**
 * Factory for ReportWriter objects based on the report type (name).
 * 
 * The passed in type can either be one of the predefined type names: "html", "xml", "console",
 * "ide", "inlineXml", or else it can specify the fully-qualified class name of a class (accessible on the
 * classpath) that implements the org.codenarc.report.ReportWriter interface.
 *
 * @author Chris Mair
 */
class ReportWriterFactory {

    ReportWriter getReportWriter(String type) {
        assert type
        switch(type) {
            case 'html': return new HtmlReportWriter()
            case 'sortable': return new SortableHtmlReportWriter()
            case 'xml': return new XmlReportWriter()
            case 'text': return new TextReportWriter()
            case 'console': def w = new TextReportWriter(); w.writeToStandardOut = true; return w
            case 'ide': def w = new IdeTextReportWriter(); w.writeToStandardOut = true; return w
            case 'inlineXml' : return new InlineXmlReportWriter()
            case 'baseline': return new BaselineXmlReportWriter()
        }

        def reportClass = getClass().classLoader.loadClass(type)
        reportClass.newInstance()
    }

    ReportWriter getReportWriter(String type, Map options) {
        def reportWriter = getReportWriter(type)
        options.each { name, value ->
            PropertyUtil.setPropertyFromString(reportWriter, name, value)
        }
        reportWriter
    }
}