net.sf.dtddoc.maven

Class DTDDocReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

net.sf.dtddoc.maven.DTDDocReport

All Implemented Interfaces:

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

@Mojo(name="dtddoc",
      threadSafe=true)
public class DTDDocReport
extends org.apache.maven.reporting.AbstractMavenReport

DTDDoc Maven2 plugin, generates DTDDoc report.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.maven.doxia.siterenderer.Renderer	siteRenderer Doxia Site Renderer.

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canGenerateReport()
protected void	executeReport(Locale locale)
void	generate(org.apache.maven.doxia.sink.Sink sink, Locale locale)
protected File	getCommonBase(File sourceDirectory, Set files)
String	getDescription(Locale locale)
protected static File[]	getFileHierarchy(File from, File to)
String	getName(Locale locale)
protected String	getOutputDirectory()
String	getOutputName()
protected org.apache.maven.project.MavenProject	getProject()
protected org.apache.maven.doxia.siterenderer.Renderer	getSiteRenderer()
boolean	isExternalReport()

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

closeReport, execute, generate, generate, getCategoryName, getInputEncoding, getOutputEncoding, getReportOutputDirectory, getSink, getSinkFactory, 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

siteRenderer

@Component
protected org.apache.maven.doxia.siterenderer.Renderer siteRenderer

Doxia Site Renderer.

Constructor Detail

DTDDocReport

public DTDDocReport()

Method Detail

getName

public String getName(Locale locale)

getDescription

public String getDescription(Locale locale)

getOutputName

public String getOutputName()

See Also:

MavenReport.getOutputName()

getOutputDirectory

protected String getOutputDirectory()

Overrides:

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

See Also:

AbstractMavenReport.getOutputDirectory()

getProject

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

Overrides:

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

See Also:

AbstractMavenReport.getProject()

getSiteRenderer

protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()

Overrides:

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

See Also:

AbstractMavenReport.getSiteRenderer()

generate

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

Overrides:

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

Throws:

org.apache.maven.reporting.MavenReportException

See Also:

MavenReport.generate(org.codehaus.doxia.sink.Sink, java.util.Locale)

executeReport

protected 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

isExternalReport

public boolean isExternalReport()

Specified by:

isExternalReport in interface org.apache.maven.reporting.MavenReport

Overrides:

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

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:

MavenReport.canGenerateReport()

getFileHierarchy

protected static File[] getFileHierarchy(File from,
                      File to)

getCommonBase

protected File getCommonBase(File sourceDirectory,
                 Set files)