org.codehaus.mojo.clirr
Class ClirrReport

java.lang.Object
  extended byorg.apache.maven.plugin.AbstractMojo
      extended byorg.codehaus.mojo.clirr.AbstractClirrMojo
          extended byorg.codehaus.mojo.clirr.ClirrReport
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.reporting.MavenReport, org.apache.maven.plugin.Mojo

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

Generate a report from the Clirr output.

Author:
Brett Porter

Field Summary
 
Fields inherited from class org.codehaus.mojo.clirr.AbstractClirrMojo
classesDirectory, comparisonVersion, excludes, factory, includes, localRepository, logResults, metadataSource, 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, java.util.Locale locale)
           
 void generate(org.codehaus.doxia.sink.Sink sink, java.util.Locale locale)
           
 java.lang.String getCategoryName()
           
 java.lang.String getDescription(java.util.Locale locale)
           
 java.lang.String getName(java.util.Locale locale)
           
 java.lang.String getOutputName()
           
 java.io.File getReportOutputDirectory()
           
 boolean isExternalReport()
           
 void setReportOutputDirectory(java.io.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 java.lang.String getCategoryName()
Specified by:
getCategoryName in interface org.apache.maven.reporting.MavenReport

setReportOutputDirectory

public void setReportOutputDirectory(java.io.File file)
Specified by:
setReportOutputDirectory in interface org.apache.maven.reporting.MavenReport

getReportOutputDirectory

public java.io.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

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException
Specified by:
execute in interface org.apache.maven.plugin.Mojo
Throws:
org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoFailureException

generate

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

getDescription

public java.lang.String getDescription(java.util.Locale locale)
Specified by:
getDescription in interface org.apache.maven.reporting.MavenReport

getName

public java.lang.String getName(java.util.Locale locale)
Specified by:
getName in interface org.apache.maven.reporting.MavenReport

getOutputName

public java.lang.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,
                     java.util.Locale locale)
              throws org.apache.maven.reporting.MavenReportException
Specified by:
generate in interface org.apache.maven.reporting.MavenReport
Throws:
org.apache.maven.reporting.MavenReportException


Copyright © 2006-2007 null. All Rights Reserved.