org.codehaus.gmavenplus.mojo

Class AbstractGroovydocMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.gmavenplus.mojo.AbstractGroovyMojo

org.codehaus.gmavenplus.mojo.AbstractGroovySourcesMojo

org.codehaus.gmavenplus.mojo.AbstractGroovydocMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

GroovydocMojo, GroovydocTestsMojo

public abstract class AbstractGroovydocMojo
extends AbstractGroovySourcesMojo

The base groovydoc mojo, which all groovydoc mojos extend.

Author:

Keegan Witt

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	displayAuthor Whether to display the author in the generated Groovydoc.
protected String	docTitle The page title.
protected String	footer The page footer.
protected boolean	groovydocJavaSources Whether to include Java sources in groovydoc generation.
protected File	groovydocOutputDirectory The location for the generated API docs.
protected String	header The page header.
protected List<Link>	links Links to include in the generated groovydoc (key is link href, value is comma-separated packages to use that link).
protected static Version	MIN_GROOVY_VERSION The minimum version of Groovy that this mojo supports.
protected File	overviewFile The HTML file to be used for overview documentation.
protected String	scope The scope to generate Groovydoc for, should be one of: "public" "protected" "package" "private"
protected String	stylesheetEncoding The encoding of stylesheetFile.
protected File	stylesheetFile The stylesheet file (absolute path) to copy to output directory (will overwrite default stylesheet.css).
protected File	testGroovydocOutputDirectory The location for the generated test API docs.
protected String	windowTitle The window title.

Fields inherited from class org.codehaus.gmavenplus.mojo.AbstractGroovySourcesMojo

MAIN, sources, TEST, testSources

Fields inherited from class org.codehaus.gmavenplus.mojo.AbstractGroovyMojo

GROOVY_SOURCES_PATTERN, JAVA_SOURCES_PATTERN, localRepository, pluginArtifacts, project, reactorProjects, session, settings

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractGroovydocMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	generateGroovydoc(org.apache.maven.shared.model.fileset.FileSet[] sourceDirectories, File outputDirectory) Generates the groovydoc for the specified sources.
protected boolean	groovyVersionSupportsAction() Determines whether this mojo can be run with the version of Groovy supplied.

Methods inherited from class org.codehaus.gmavenplus.mojo.AbstractGroovySourcesMojo

getFiles, getFilesets, getSourceRoots, getSourceRoots, getSources, getSources, getTestSourceRoots, getTestSourceRoots, getTestSources, getTestSources, setSources, setTestSources

Methods inherited from class org.codehaus.gmavenplus.mojo.AbstractGroovyMojo

getGroovyDependency, getGroovyVersion, getGroovyVersionString, getJavaVersion, getJavaVersionString, isGroovyArtifactId, isGroovyArtifactId, isGroovyGroupId, isGroovyGroupId, isGroovyIndy, isJavaSupportIndy, logGroovyVersion

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

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

execute

Field Detail

MIN_GROOVY_VERSION

protected static final Version MIN_GROOVY_VERSION

The minimum version of Groovy that this mojo supports.

groovydocOutputDirectory

protected File groovydocOutputDirectory

The location for the generated API docs.

testGroovydocOutputDirectory

protected File testGroovydocOutputDirectory

The location for the generated test API docs.

windowTitle

protected String windowTitle

The window title.

docTitle

protected String docTitle

The page title.

footer

protected String footer

The page footer.

header

protected String header

The page header.

displayAuthor

protected boolean displayAuthor

Whether to display the author in the generated Groovydoc.

overviewFile

protected File overviewFile

The HTML file to be used for overview documentation.

stylesheetFile

protected File stylesheetFile

The stylesheet file (absolute path) to copy to output directory (will overwrite default stylesheet.css).

stylesheetEncoding

protected String stylesheetEncoding

The encoding of stylesheetFile.

scope

protected String scope

The scope to generate Groovydoc for, should be one of:

• "public"
• "protected"
• "package"
• "private"

links

protected List<Link> links

Links to include in the generated groovydoc (key is link href, value is comma-separated packages to use that link).

groovydocJavaSources

protected boolean groovydocJavaSources

Whether to include Java sources in groovydoc generation.

Constructor Detail

AbstractGroovydocMojo

public AbstractGroovydocMojo()

Method Detail

generateGroovydoc

protected void generateGroovydoc(org.apache.maven.shared.model.fileset.FileSet[] sourceDirectories,
                     File outputDirectory)
                          throws ClassNotFoundException,
                                 InvocationTargetException,
                                 IllegalAccessException,
                                 InstantiationException

Generates the groovydoc for the specified sources.

Parameters:

sourceDirectories - The source directories to generate groovydoc for

outputDirectory - The directory to save the generated groovydoc in

Throws:

ClassNotFoundException - When a class needed for groovydoc generation cannot be found

InstantiationException - When a class needed for groovydoc generation cannot be instantiated

IllegalAccessException - When a method needed for groovydoc generation cannot be accessed

InvocationTargetException - When a reflection invocation needed for groovydoc generation cannot be completed

groovyVersionSupportsAction

protected boolean groovyVersionSupportsAction()

Determines whether this mojo can be run with the version of Groovy supplied. Must be >= 1.6.2 because not all the classes/methods needed were available and functioning correctly in previous versions.

Returns:

true only if the version of Groovy supports this mojo