org.codehaus.mojo.findbugs.FindbugsXdocSink.groovy Maven / Gradle / Ivy

Go to download

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

This Plug-In generates reports based on the FindBugs Library

There is a newer version: 3.0.5

Show newest version

package org.codehaus.mojo.findbugs;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 */

import java.io.Writer

import org.apache.maven.doxia.module.HtmlTools
import org.apache.maven.doxia.sink.SinkAdapter
import org.apache.maven.doxia.util.LineBreaker

/**
 * A doxia Sink which produces an FindBugs model.
 *
 * @author Garvin LeClaire
 * @version $Id: FindbugsXdocSink.groovy 7078 2008-05-29 04:10:38Z gleclaire $
 */
class FindbugsXdocSink extends SinkAdapter
{

    String xdocEncoding
    static final String EOL = System.getProperty("line.separator")

    LineBreaker out

    FindbugsXdocSink(Writer out)
    {
        this.out = new LineBreaker(out)
        this.xdocEncoding = out.getEncoding()
    }

    void analysisErrorTag(String className)
    {
        this.markup("")
        this.markup(HtmlTools.escapeHTML(className))
        this.markup(" " + EOL)
    }

    void body()
    {
        this.markup("" + EOL)
    }

    void body(String version, String threshold, String effort)
    {
        this.markup("" + EOL);
    }

    void body_()
    {
        this.markup("" + EOL)
        this.out.flush();
    }

    void bugInstance(String type, String priority, String category, String message, String lineNumber)
    {
        this.markup("" + EOL)
    }

    void classTag(String className)
    {
        this.markup("" + EOL)
    }

    void classTag_()
    {
        this.markup("" + EOL)
    }

    void close()
    {
        this.out.close()
    }

    void errorTag()
    {
        this.markup("" + EOL)
    }

    void errorTag_()
    {
        this.markup("" + EOL)
    }

    void flush()
    {
        this.out.flush()
    }

    void head()
    {
        this.markup("" + EOL)
    }

    void missingClassTag(String className)
    {
        this.markup("")
        this.markup(HtmlTools.escapeHTML(className))
        this.markup(" " + EOL)
    }

    protected void markup(String text)
    {
        this.out.write(text, true)
    }

    void ProjectTag()
    {
        this.markup("" + EOL)
    }

    void ProjectTag_()
    {
        this.markup("" + EOL)
    }

    void srcDirTag(String className)
    {
        this.markup("")
        this.markup(HtmlTools.escapeHTML(className))
        this.markup("" + EOL)
    }
}