org.codehaus.mojo.clirr

Class ClirrReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.clirr.AbstractClirrMojo

org.codehaus.mojo.clirr.ClirrReport

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenReport

public class ClirrReport
extends AbstractClirrMojo
implements org.apache.maven.reporting.MavenReport

Generate a report from the Clirr output.

Author:

Brett Porter

Is defined by the goal name:

clirr

Is defined to be executed in:

phase:

compile

Field Summary

Fields inherited from class org.codehaus.mojo.clirr.AbstractClirrMojo

classesDirectory, comparisonArtifacts, comparisonVersion, excludes, factory, ignored, ignoredDifferencesFile, includes, localRepository, logResults, minSeverity, project, resolver, skip, textOutputFile, xmlOutputFile

Fields inherited from interface org.apache.maven.reporting.MavenReport

CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
ClirrReport()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canGenerateReport()
protected void	doExecute()
void	generate(org.apache.maven.doxia.sink.Sink sink, Locale locale)
void	generate(org.codehaus.doxia.sink.Sink sink, Locale locale)
String	getCategoryName()
String	getDescription(Locale locale)
String	getName(Locale locale)
String	getOutputName()
File	getReportOutputDirectory()
boolean	isExternalReport()
void	setReportOutputDirectory(File file)

Methods inherited from class org.codehaus.mojo.clirr.AbstractClirrMojo

canGenerate, convertSeverity, createClassLoader, createClassSet, execute, executeClirr, executeClirr, getAllIgnored, getTransitiveDependencies, resolveArtifacts

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClirrReport

public ClirrReport()

Method Detail

getCategoryName

public String getCategoryName()

Specified by:

getCategoryName in interface org.apache.maven.reporting.MavenReport

setReportOutputDirectory

public void setReportOutputDirectory(File file)

Specified by:

setReportOutputDirectory in interface org.apache.maven.reporting.MavenReport

getReportOutputDirectory

public File getReportOutputDirectory()

Specified by:

getReportOutputDirectory in interface org.apache.maven.reporting.MavenReport

isExternalReport

public boolean isExternalReport()

Specified by:

isExternalReport in interface org.apache.maven.reporting.MavenReport

doExecute

protected void doExecute()
                  throws org.apache.maven.plugin.MojoExecutionException,
                         org.apache.maven.plugin.MojoFailureException

Specified by:

doExecute in class AbstractClirrMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

generate

public void generate(org.apache.maven.doxia.sink.Sink sink,
            Locale locale)
              throws org.apache.maven.reporting.MavenReportException

Throws:

org.apache.maven.reporting.MavenReportException

getDescription

public String getDescription(Locale locale)

Specified by:

getDescription in interface org.apache.maven.reporting.MavenReport

getName

public String getName(Locale locale)

Specified by:

getName in interface org.apache.maven.reporting.MavenReport

getOutputName

public String getOutputName()

Specified by:

getOutputName in interface org.apache.maven.reporting.MavenReport

canGenerateReport

public boolean canGenerateReport()

Specified by:

canGenerateReport in interface org.apache.maven.reporting.MavenReport

generate

public void generate(org.codehaus.doxia.sink.Sink sink,
            Locale locale)
              throws org.apache.maven.reporting.MavenReportException

Specified by:

generate in interface org.apache.maven.reporting.MavenReport

Throws:

org.apache.maven.reporting.MavenReportException