org.apache.clerezza.jaxrsreportplugin

Class JaxRsReportMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.apache.clerezza.jaxrsreportplugin.JaxRsReportMojo

All Implemented Interfaces:

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

public class JaxRsReportMojo
extends org.apache.maven.reporting.AbstractMavenReport

Generates a report about jaxrs resources. The report includes java doc descriptions about paths, http methods, comments and parameters of the methods. The report will be generated in the site phase, the default goal is jaxrs-report.

Field Summary

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
JaxRsReportMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	executeReport(Locale arg0)
String	getDescription(Locale locale)
String	getName(Locale locale)
protected String	getOutputDirectory()
String	getOutputName()
protected org.apache.maven.project.MavenProject	getProject()
protected org.codehaus.doxia.site.renderer.SiteRenderer	getSiteRenderer()
com.thoughtworks.qdox.model.JavaSource[]	getSources()
boolean	hasPathAnnotation(com.thoughtworks.qdox.model.AbstractBaseJavaEntity entity)

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

canGenerateReport, closeReport, execute, 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

JaxRsReportMojo

public JaxRsReportMojo()

Method Detail

getSiteRenderer

protected org.codehaus.doxia.site.renderer.SiteRenderer getSiteRenderer()

Specified by:

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

getOutputDirectory

protected String getOutputDirectory()

Specified by:

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

getProject

protected org.apache.maven.project.MavenProject getProject()

Specified by:

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

executeReport

protected void executeReport(Locale arg0)
                      throws org.apache.maven.reporting.MavenReportException

Specified by:

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

Throws:

org.apache.maven.reporting.MavenReportException

getOutputName

public String getOutputName()

getName

public String getName(Locale locale)

getDescription

public String getDescription(Locale locale)

hasPathAnnotation

public boolean hasPathAnnotation(com.thoughtworks.qdox.model.AbstractBaseJavaEntity entity)

getSources

public com.thoughtworks.qdox.model.JavaSource[] getSources()