org.codehaus.mojo.springbeandoc
Class SpringBeanDocMojo

java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.apache.maven.reporting.AbstractMavenReport
          extended by org.codehaus.mojo.springbeandoc.SpringBeanDocMojo
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenReport

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

Spring BeanDoc report generator that can be used as a Maven 2 plugin or a Maven 2 site report.

Author:
Jurgen De Landsheer, Marat Radchenko
See Also:
Spring BeanDoc, GraphViz

Field Summary
protected static java.lang.String SUBDIRECTORY
          Subdirectory for report.
 
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
SpringBeanDocMojo()
           
 
Method Summary
protected  java.io.File buildConfig(java.io.File outputDir, java.util.Locale locale)
          Builds beandoc config file.
 void execute()
           
protected  void executeReport(java.util.Locale locale)
           
protected  java.util.ResourceBundle getBundle(java.util.Locale locale)
          Gets resource bundle for given locale.
 java.lang.String getDescription(java.util.Locale locale)
           
 java.lang.String getName(java.util.Locale locale)
           
protected  java.lang.String getOutputDirectory()
           
 java.lang.String getOutputName()
           
protected  org.apache.maven.project.MavenProject getProject()
           
protected  org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
           
 
Methods inherited from class org.apache.maven.reporting.AbstractMavenReport
canGenerateReport, closeReport, generate, generate, generate, getCategoryName, getReportOutputDirectory, getSink, getSinkFactory, 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
 

Field Detail

SUBDIRECTORY

protected static final java.lang.String SUBDIRECTORY
Subdirectory for report.

See Also:
Constant Field Values
Constructor Detail

SpringBeanDocMojo

public SpringBeanDocMojo()
Method Detail

getDescription

public java.lang.String getDescription(java.util.Locale locale)
Parameters:
locale - report locale.
Returns:
report description.
See Also:
MavenReport.getDescription(java.util.Locale)

getName

public java.lang.String getName(java.util.Locale locale)
See Also:
MavenReport.getName(java.util.Locale)

getOutputName

public java.lang.String getOutputName()
See Also:
MavenReport.getOutputName()

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException
Specified by:
execute in interface org.apache.maven.plugin.Mojo
Overrides:
execute in class org.apache.maven.reporting.AbstractMavenReport
Throws:
org.apache.maven.plugin.MojoExecutionException
See Also:
Mojo.execute()

buildConfig

protected java.io.File buildConfig(java.io.File outputDir,
                                   java.util.Locale locale)
                            throws java.io.IOException
Builds beandoc config file.

Parameters:
outputDir - target directory
locale - locale
Returns:
path to config file.
Throws:
java.io.IOException - exception

executeReport

protected void executeReport(java.util.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)

getBundle

protected java.util.ResourceBundle getBundle(java.util.Locale locale)
Gets resource bundle for given locale.

Parameters:
locale - locale
Returns:
resource bundle

getSiteRenderer

protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
Specified by:
getSiteRenderer in class org.apache.maven.reporting.AbstractMavenReport

getOutputDirectory

protected java.lang.String getOutputDirectory()
Specified by:
getOutputDirectory in class org.apache.maven.reporting.AbstractMavenReport
See Also:
AbstractMavenReport.getOutputDirectory()

getProject

protected org.apache.maven.project.MavenProject getProject()
Specified by:
getProject in class org.apache.maven.reporting.AbstractMavenReport


Copyright © 2006-2009. All Rights Reserved.