net.sf.dtddoc.maven2
Class DTDDocReport

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

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

DTDDoc Maven2 plugin.

Version:
$Id: DTDDocReport.java,v 1.12 2006/10/28 08:30:45 hboutemy Exp $

Field Summary
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
DTDDocReport()
           
 
Method Summary
 boolean canGenerateReport()
           
protected  void executeReport(java.util.Locale locale)
           
 void generate(org.apache.maven.doxia.sink.Sink sink, java.util.Locale locale)
           
protected  java.io.File getCommonBase(java.io.File sourceDirectory, java.util.Set files)
           
 java.lang.String getDescription(java.util.Locale locale)
           
protected static java.io.File[] getFileHierarchy(java.io.File from, java.io.File to)
           
 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()
           
 boolean isExternalReport()
           
 
Methods inherited from class org.apache.maven.reporting.AbstractMavenReport
closeReport, execute, generate, generate, getCategoryName, 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

protected org.apache.maven.doxia.siterenderer.Renderer siteRenderer
Doxia Site Renderer.

Constructor Detail

DTDDocReport

public DTDDocReport()
Method Detail

getName

public java.lang.String getName(java.util.Locale locale)

getDescription

public java.lang.String getDescription(java.util.Locale locale)

getOutputName

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

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

generate

public void generate(org.apache.maven.doxia.sink.Sink sink,
                     java.util.Locale locale)
              throws org.apache.maven.reporting.MavenReportException
Specified by:
generate in interface org.apache.maven.reporting.MavenReport
Overrides:
generate in class org.apache.maven.reporting.AbstractMavenReport
Throws:
org.apache.maven.reporting.MavenReportException
See Also:
org.apache.maven.reporting.MavenReport#generate(org.codehaus.doxia.sink.Sink, java.util.Locale)

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

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 java.io.File[] getFileHierarchy(java.io.File from,
                                                 java.io.File to)

getCommonBase

protected java.io.File getCommonBase(java.io.File sourceDirectory,
                                     java.util.Set files)


Copyright © 2006-2009 DTDDoc. All Rights Reserved.