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

AbstractJsDocsMojo()

Method Summary

protected void	archive(File archiveDir) Archive the directory of the jsdocs
protected List<String>	createArgumentStack(Set<File> files)
protected void	createJsDocs()
void	execute()
protected void	executeJSDocs(List<String> args)
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 File getBaseDir()

isCaseSensitive

public boolean isCaseSensitive()

Returns:

the caseSensitive

isUseNamespacedFiles

public boolean isUseNamespacedFiles()

Returns:

the useNamespacedFiles

getTemplate

public File getTemplate()

Returns:

the template

isIncludePrivate

public boolean isIncludePrivate()

Returns:

the includePrivate

getToolkitExtractDirectory

public File getToolkitExtractDirectory()

Returns:

the toolkitExtractDirectory

getFinalName

protected String getFinalName()

Returns:

finalName

execute

public 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 void createJsDocs()
                     throws org.apache.maven.reporting.MavenReportException,
                            IOException

Throws:

org.apache.maven.reporting.MavenReportException

IOException

executeJSDocs

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

Throws:

org.apache.maven.reporting.MavenReportException

createArgumentStack

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

setConsoleOuput

protected void setConsoleOuput()

Will output the console jsdoc creation logs to log4j

archive

protected void archive(File archiveDir)
                throws IOException

Archive the directory of the jsdocs

Parameters:

location - the location

Throws:

IOException

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

Returns:

destDir