de.smartics.maven.exceptions
Class ExceptionCodeReport

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.reporting.AbstractMavenReport
          de.smartics.maven.exceptions.AbstractElementReport
              de.smartics.maven.exceptions.ExceptionCodeReport

All Implemented Interfaces:

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

public class ExceptionCodeReport
     
     

      
      extends 
      
      AbstractElementReport
     
     

Generates exception code documentation.

Author:

Robert Reiner

maven-goal:

exception-codes-report

maven-phase:

site

maven-requiresProject:

maven-requiresDependencyResolution:

maven-description:

Generates documentation for the exception codes used in the project.

Field Summary

Fields inherited from class de.smartics.maven.exceptions.AbstractElementReport

factory, javadocDir, locale, localRepository, logLevel, outputDirectory, pluginArtifacts, project, resolver, siteRenderer

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

ExceptionCodeReport()

Method Summary

void	executeReport(Locale locale)
protected String	getBundleName() Returns the name of the bundle to load to label report information.
String	getOutputName()

Methods inherited from class de.smartics.maven.exceptions.AbstractElementReport

canGenerateReport, execute, getBundle, getDescription, getName, getOutputDirectory, getProject, getSiteRenderer, provideSink, setProject

Methods inherited from class org.apache.maven.reporting.AbstractMavenReport

closeReport, generate, getCategoryName, getReportOutputDirectory, getSink, isExternalReport, setReportOutputDirectory

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

ExceptionCodeReport

public ExceptionCodeReport()

Method Detail

getOutputName

public String getOutputName()

See Also:

MavenReport.getOutputName()

executeReport

public void executeReport(Locale locale)
                   throws org.apache.maven.reporting.MavenReportException

Specified by:

executeReport in class org.apache.maven.reporting.AbstractMavenReport

Throws:

org.apache.maven.reporting.MavenReportException

See Also:

AbstractMavenReport.executeReport(java.util.Locale)

getBundleName

protected String getBundleName()

Returns the name of the bundle to load to label report information.

Specified by:

getBundleName in class AbstractElementReport

Returns:

the name of the bundle to load to label report information.

See Also:

AbstractElementReport.getBundle(Locale)