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:

ContextEnabled, MavenReport, Mojo

public class ClirrReport

extends AbstractClirrMojo

implements MavenReport

Generate a report from the Clirr output.

Author:

Brett Porter

Is defined by the goal name:

clirr

Field Summary

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

classesDirectory, comparisonArtifacts, comparisonVersion, excludes, factory, includes, localRepository, logResults, project, resolver, 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

ClirrReport()

Method Summary

boolean	canGenerateReport()
void	execute()
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, createClassSet, executeClirr, executeClirr

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 MavenReport

setReportOutputDirectory

public void setReportOutputDirectory(File file)

Specified by:

setReportOutputDirectory in interface MavenReport

getReportOutputDirectory

public File getReportOutputDirectory()

Specified by:

getReportOutputDirectory in interface MavenReport

isExternalReport

public boolean isExternalReport()

Specified by:

isExternalReport in interface MavenReport

execute

public void execute()
             throws MojoExecutionException,
                    MojoFailureException

Specified by:

execute in interface Mojo

Throws:

MojoExecutionException

MojoFailureException

generate

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

Throws:

MavenReportException

getDescription

public String getDescription(Locale locale)

Specified by:

getDescription in interface MavenReport

getName

public String getName(Locale locale)

Specified by:

getName in interface MavenReport

getOutputName

public String getOutputName()

Specified by:

getOutputName in interface MavenReport

canGenerateReport

public boolean canGenerateReport()

Specified by:

canGenerateReport in interface MavenReport

generate

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

Specified by:

generate in interface MavenReport

Throws:

MavenReportException