com.github.jlgrock.javascriptframework.jsdocs

Class JsDocsReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.github.jlgrock.javascriptframework.jsdocs.AbstractJsDocsMojo

com.github.jlgrock.javascriptframework.jsdocs.JsDocsReport

All Implemented Interfaces:

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

public class JsDocsReport
extends AbstractJsDocsMojo
implements org.apache.maven.reporting.MavenReport

Generates javascript docs from the jsdoc-toolkit (the final version).

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

Constructors

Constructor and Description
JsDocsReport() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canGenerateReport()
void	generate(org.codehaus.doxia.sink.Sink aSink, Locale aLocale) Generates the report.
void	generate(org.apache.maven.doxia.sink.Sink aSink, Locale aLocale) Generates the report.
void	generate(org.apache.maven.doxia.sink.Sink aSink, org.apache.maven.doxia.sink.SinkFactory aSinkFactory, Locale aLocale) This method is called when the report generation is invoked by maven-site-plugin.
protected File	getArchiveOutputDirectory() return the file location of where the archive of the jsdocs should be placed.
String	getCategoryName()
protected String	getClassifier() The classifier that will be used for the file name.
String	getDescription()
String	getDescription(Locale locale)
String	getName()
String	getName(Locale locale)
String	getOutputName()
File	getReportOutputDirectory()
ArrayList<File>	getSourceDirectories()
protected boolean	isAggregator()
boolean	isExternalReport()
boolean	isFailOnError()
void	setReportOutputDirectory(File reportOutputDirectoryIn)

Methods inherited from class com.github.jlgrock.javascriptframework.jsdocs.AbstractJsDocsMojo

archive, createArgumentStack, createJsDocs, execute, executeJSDocs, getBaseDir, getDestDir, getFinalName, getOutputDirectory, getTemplate, getToolkitExtractDirectory, isCaseSensitive, isIncludePrivate, isUseNamespacedFiles, setConsoleOuput, setOutputDirectory

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

JsDocsReport

public JsDocsReport()

Constructor.

Method Detail

getName

public final String getName()

Returns:

the name

getDescription

public final String getDescription()

Returns:

the description

isFailOnError

public final boolean isFailOnError()

Returns:

the failOnError

getDescription

public String getDescription(Locale locale)

Specified by:

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

getName

public String getName(Locale locale)

Specified by:

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

getOutputName

public String getOutputName()

Specified by:

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

isExternalReport

public boolean isExternalReport()

Specified by:

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

generate

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

Generates the report.

Specified by:

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

Parameters:

aSink - the sink passed in by maven

aLocale - the locale to adjust for

Throws:

org.apache.maven.reporting.MavenReportException - if there is a problem with the generate

generate

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

Generates the report.

Parameters:

aSink - the sink passed in by maven

aLocale - the locale to adjust for

Throws:

org.apache.maven.reporting.MavenReportException - if there is a problem with the generate

generate

public final void generate(org.apache.maven.doxia.sink.Sink aSink,
            org.apache.maven.doxia.sink.SinkFactory aSinkFactory,
            Locale aLocale)
                    throws org.apache.maven.reporting.MavenReportException

This method is called when the report generation is invoked by maven-site-plugin.

Parameters:

aSink - the Sink passed by Maven

aSinkFactory - the Sink factory passed by Maven

aLocale - the locale

Throws:

org.apache.maven.reporting.MavenReportException - if there are any problems with generation

getReportOutputDirectory

public final File getReportOutputDirectory()

Specified by:

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

setReportOutputDirectory

public final void setReportOutputDirectory(File reportOutputDirectoryIn)

Specified by:

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

getCategoryName

public final String getCategoryName()

Specified by:

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

canGenerateReport

public final boolean canGenerateReport()

Specified by:

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

getSourceDirectories

public final ArrayList<File> getSourceDirectories()

Specified by:

getSourceDirectories in class AbstractJsDocsMojo

Returns:

the sourceDirectory

isAggregator

protected final boolean isAggregator()

Specified by:

isAggregator in class AbstractJsDocsMojo

Returns:

aggregator

getClassifier

protected final String getClassifier()

Description copied from class: AbstractJsDocsMojo

The classifier that will be used for the file name.

Specified by:

getClassifier in class AbstractJsDocsMojo

Returns:

the classifier

getArchiveOutputDirectory

protected final File getArchiveOutputDirectory()

Description copied from class: AbstractJsDocsMojo

return the file location of where the archive of the jsdocs should be placed. This should return null if no archive is expected to be created.

Specified by:

getArchiveOutputDirectory in class AbstractJsDocsMojo

Returns:

the output directory or null