net.sf.jfxdplugin
Class JavafxdocReport

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      net.sf.jfxdplugin.AbstractJavafxdocMojo
          net.sf.jfxdplugin.JavafxdocReport

All Implemented Interfaces:

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

public class JavafxdocReport
extends AbstractJavafxdocMojo
implements org.apache.maven.reporting.MavenReport

Generates documentation for the JavaFX code in a NON aggregator project using the standard Javafxdoc Tool.

Based on the Maven Javadoc Plugin version 2.6.

Since:

1.0

Version:

$Revision: 38 $ $Date: 2010-03-19 22:40:25 -0400 (Fri, 19 Mar 2010) $

Author:

Nathan Erwin, Emmanuel Venisse, Vincent Siveton

See Also:

http://maven.apache.org/plugins/maven-javadoc-plugin

Field Summary

Fields inherited from class net.sf.jfxdplugin.AbstractJavafxdocMojo

DEBUG_JAVAFXDOC_SCRIPT_NAME, DEFAULT_JAVA_API_LINKS, DEFAULT_JAVAFX_VERSION, FILES_FILE_NAME, OPTIONS_FILE_NAME, SINCE_JAVAFXDOC_1_3

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

JavafxdocReport()

Method Summary

boolean	canGenerateReport()
void	execute() Entry point for the javafxdoc goal.
void	generate(org.codehaus.doxia.sink.Sink sink, Locale locale)
String	getCategoryName()
String	getDescription(Locale locale)
String	getDestDir() Returns the destination directory for the HTML output.
String	getName(Locale locale)
String	getOutputName()
File	getReportOutputDirectory()
boolean	isExternalReport()
void	setDestDir(String destDir) Sets the destination directory for the HTML output.
void	setReportOutputDirectory(File outputDirectory)

Methods inherited from class net.sf.jfxdplugin.AbstractJavafxdocMojo

canGenerateReport, executeReport, formatMessage, getAdditionalJOptions, getAdditionalXslOptions, getBootclasspath, getBundle, getDoclet, getDocletPath, getEncoding, getExcludePackageNames, getExtdirs, getExtracss, getExtrajs, getFiles, getInputFiles, getJavafxdocExecutable, getJavafxdocVersion, getLocale, getLocaleObject, getMastercss, getOutputDirectory, getOutputFile, getProfile, getProject, getProjectArtifacts, getSession, getShow, getSource, getSourcePath, getSourcePaths, getSubpackages, getToolchainManager, getXsltfile, isBreakiterator, isDebug, isFailOnError, isNohtml, isQuiet, isVerbose, setAdditionalJOptions, setAdditionalXslOptions, setBootclasspath, setBreakiterator, setDebug, setDoclet, setDocletPath, setEncoding, setExcludePackageNames, setExtdirs, setExtracss, setExtrajs, setFailOnError, setInputFiles, setJavafxdocExecutable, setLocale, setMastercss, setNohtml, setOutputDirectory, setOutputFile, setProfile, setProject, setQuiet, setShow, setSource, setSourcePath, setSubpackages, setToolchainManager, setVerbose, setXsltfile

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

JavafxdocReport

public JavafxdocReport()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Entry point for the javafxdoc goal.

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Throws:

org.apache.maven.plugin.MojoExecutionException - if an exception occurred during the execution of the plugin

org.apache.maven.plugin.MojoFailureException - not thrown

generate

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

Specified by:

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

Throws:

org.apache.maven.reporting.MavenReportException

getOutputName

public String getOutputName()

Specified by:

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

getCategoryName

public String getCategoryName()

Specified by:

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

getName

public String getName(Locale locale)

Specified by:

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

getDescription

public String getDescription(Locale locale)

Specified by:

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

setReportOutputDirectory

public void setReportOutputDirectory(File outputDirectory)

Specified by:

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

getReportOutputDirectory

public File getReportOutputDirectory()

Specified by:

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

isExternalReport

public boolean isExternalReport()

Specified by:

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

canGenerateReport

public boolean canGenerateReport()

Specified by:

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

getDestDir

public String getDestDir()

Returns the destination directory for the HTML output.

Returns:

the destination directory

setDestDir

public void setDestDir(String destDir)

Sets the destination directory for the HTML output.

Parameters:

destDir - the destination directory