net.sf.maventaglib
Class TagreferenceMojo

java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.apache.maven.reporting.AbstractMavenReport
          extended by net.sf.maventaglib.TagreferenceMojo
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenReport

public class TagreferenceMojo
extends org.apache.maven.reporting.AbstractMavenReport
implements org.apache.maven.reporting.MavenReport

Generates a tag reference xdoc that can be integrated in a maven generated site.

Version:
$Id: TagreferenceMojo.java 206 2010-01-31 09:37:21Z fgiust $
Author:
Fabrizio Giustina

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
TagreferenceMojo()
           
 
Method Summary
 boolean canGenerateReport()
           
protected  void executeReport(java.util.Locale 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()
           
 void setOutputDirectory(java.io.File outputDirectory)
          Setter for outputDirectory.
 void setProject(org.apache.maven.project.MavenProject project)
          Setter for project.
 void setSrcDir(java.io.File srcDir)
          Setter for srcDir.
 boolean usePageLinkBar()
           
 
Methods inherited from class org.apache.maven.reporting.AbstractMavenReport
closeReport, execute, 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
 
Methods inherited from interface org.apache.maven.reporting.MavenReport
generate, getCategoryName, getReportOutputDirectory, isExternalReport, setReportOutputDirectory
 

Constructor Detail

TagreferenceMojo

public TagreferenceMojo()
Method Detail

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
See Also:
AbstractMavenReport.getProject()

getSiteRenderer

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

getOutputName

public java.lang.String getOutputName()
Specified by:
getOutputName in interface org.apache.maven.reporting.MavenReport
See Also:
MavenReport.getOutputName()

getName

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

getDescription

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

setSrcDir

public void setSrcDir(java.io.File srcDir)
Setter for srcDir.

Parameters:
srcDir - The srcDir to set.

setOutputDirectory

public void setOutputDirectory(java.io.File outputDirectory)
Setter for outputDirectory.

Parameters:
outputDirectory - The outputDirectory to set.

setProject

public void setProject(org.apache.maven.project.MavenProject project)
Setter for project.

Parameters:
project - The project to set.

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)

canGenerateReport

public boolean canGenerateReport()
Specified by:
canGenerateReport in interface org.apache.maven.reporting.MavenReport
Overrides:
canGenerateReport in class org.apache.maven.reporting.AbstractMavenReport
See Also:
AbstractMavenReport.canGenerateReport()

usePageLinkBar

public boolean usePageLinkBar()


Copyright © 2004-2011 Fabrizio Giustina. All Rights Reserved.