com.github.jlgrock.javascriptframework.jsdocs

Class AbstractJsDocsMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.github.jlgrock.javascriptframework.jsdocs.AbstractJsDocsMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

JsDocsMojo, JsDocsReport

public abstract class AbstractJsDocsMojo
extends org.apache.maven.plugin.AbstractMojo

The abstract jsdoc creation class.

Field Summary

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractJsDocsMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	archive(File archiveDir) Archive the directory of the jsdocs.
protected List<String>	createArgumentStack(Set<File> files) Create a list of arguments for the jsdoc toolkit.
protected void	createJsDocs() Creates the js docs.
void	execute()
protected void	executeJSDocs(List<String> args) Execute the jsdoc toolkit executable.
protected abstract File	getArchiveOutputDirectory() return the file location of where the archive of the jsdocs should be placed.
protected File	getBaseDir()
protected abstract String	getClassifier() The classifier that will be used for the file name.
String	getDestDir()
protected String	getFinalName()
File	getOutputDirectory()
abstract ArrayList<File>	getSourceDirectories()
File	getTemplate()
File	getToolkitExtractDirectory()
protected abstract boolean	isAggregator()
boolean	isCaseSensitive()
boolean	isIncludePrivate()
boolean	isUseNamespacedFiles()
protected void	setConsoleOuput() Will output the console jsdoc creation logs to log4j.
void	setOutputDirectory(File outputDirectoryIn)

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

AbstractJsDocsMojo

public AbstractJsDocsMojo()

Method Detail

getBaseDir

protected final File getBaseDir()

Returns:

the base directory

isCaseSensitive

public final boolean isCaseSensitive()

Returns:

the caseSensitive

isUseNamespacedFiles

public final boolean isUseNamespacedFiles()

Returns:

the useNamespacedFiles

getTemplate

public final File getTemplate()

Returns:

the template

isIncludePrivate

public final boolean isIncludePrivate()

Returns:

the includePrivate

getToolkitExtractDirectory

public final File getToolkitExtractDirectory()

Returns:

the toolkitExtractDirectory

getFinalName

protected final String getFinalName()

Returns:

finalName

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

createJsDocs

protected final void createJsDocs()
                           throws org.apache.maven.reporting.MavenReportException,
                                  IOException

Creates the js docs.

Throws:

org.apache.maven.reporting.MavenReportException - if there is a problem in the creation of jsdocs

IOException - if there is a problem writing the files

executeJSDocs

protected final void executeJSDocs(List<String> args)
                            throws org.apache.maven.reporting.MavenReportException

Execute the jsdoc toolkit executable.

Parameters:

args - the list of arguments for the jsdoc toolkit

Throws:

org.apache.maven.reporting.MavenReportException - for any reporting exception

createArgumentStack

protected final List<String> createArgumentStack(Set<File> files)

Create a list of arguments for the jsdoc toolkit.

Parameters:

files - the files to create jsdocs for

Returns:

the list of arguments

setConsoleOuput

protected final void setConsoleOuput()

Will output the console jsdoc creation logs to log4j.

archive

protected final void archive(File archiveDir)
                      throws IOException

Archive the directory of the jsdocs.

Parameters:

archiveDir - the location to write the archive

Throws:

IOException - If there is a problem unzipping to the directory

getSourceDirectories

public abstract ArrayList<File> getSourceDirectories()

Returns:

the sourceDirectory

isAggregator

protected abstract boolean isAggregator()

Returns:

aggregator

getOutputDirectory

public final File getOutputDirectory()

Returns:

outputDirectory

setOutputDirectory

public final void setOutputDirectory(File outputDirectoryIn)

Parameters:

outputDirectoryIn - the outputDirectory to set it to

getClassifier

protected abstract String getClassifier()

The classifier that will be used for the file name.

Returns:

the classifier

getArchiveOutputDirectory

protected abstract File getArchiveOutputDirectory()

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.

Returns:

the output directory or null

getDestDir

public final String getDestDir()

Returns:

destDir