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.

Since:

1.0-beta-1

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	displayAuthor Whether to display the author in the generated Groovydoc.
protected java.lang.String	docTitle The page title.
protected java.lang.String	footer The page footer.
protected static Version	GROOVY_1_5_2 Groovy 1.5.2 version.
protected static Version	GROOVY_1_5_8 Groovy 1.5.8 version.
protected static Version	GROOVY_1_6_0_RC1 Groovy 1.6.0 RC-1 version.
protected static Version	GROOVY_1_6_0_RC2 Groovy 1.6.0 RC-2 version.
protected boolean	groovydocJavaSources Whether to include Java sources in groovydoc generation.
protected java.io.File	groovydocOutputDirectory The location for the generated API docs.
protected java.lang.String	header The page header.
protected java.util.List<Link>	links Links to include in the generated groovydoc (key is link href, value is comma-separated packages to use that link).
protected java.io.File	overviewFile The HTML file to be used for overview documentation.
protected java.lang.String	scope The scope to generate Groovydoc for.
protected java.lang.String	stylesheetEncoding The encoding of stylesheetFile.
protected java.io.File	stylesheetFile The stylesheet file (absolute path) to copy to output directory (will overwrite default stylesheet.css).
protected java.io.File	testGroovydocOutputDirectory The location for the generated test API docs.
protected java.lang.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

classWrangler, GROOVY_1_5_0, GROOVY_SOURCES_PATTERN, JAVA_1_7, JAVA_SOURCES_PATTERN, minGroovyVersion, mojoExecution, pluginArtifacts, project, session, skipTests

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractGroovydocMojo()

Method Summary

Modifier and Type	Method and Description
protected void	copyStylesheet(java.io.File outputDirectory) Copies the stylesheet to the specified output directory.
protected java.lang.Object	createGroovyDocTool(java.lang.Class groovyDocToolClass, java.lang.Class resourceManagerClass, java.util.Properties docProperties, java.lang.Object classpathResourceManager, java.util.List<java.lang.String> sourceDirectories, GroovyDocTemplateInfo groovyDocTemplateInfo, java.util.List groovydocLinks) Instantiates a new GroovyDocTool.
protected void	doGroovydocGeneration(org.apache.maven.shared.model.fileset.FileSet[] sourceDirectories, java.util.List classpath, java.io.File outputDirectory) Generates the Groovydoc for the specified sources.
protected void	generateGroovydoc(java.io.File outputDirectory, java.lang.Class groovyDocToolClass, java.lang.Class outputToolClass, java.lang.Object fileOutputTool, java.util.List<java.lang.String> groovydocSources, java.lang.Object groovyDocTool) Performs the Groovydoc generation.
protected java.util.List<java.lang.String>	setupGroovyDocSources(org.apache.maven.shared.model.fileset.FileSet[] sourceDirectories, org.apache.maven.shared.model.fileset.util.FileSetManager fileSetManager) Gets the Groovy sources without the Java sources (since the Java sources don't have Javadoc).
protected java.util.List	setupLinks() Sets up the Groovydoc links.
protected java.util.Properties	setupProperties() Sets up the documentation properties.

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

getJavaVersion, getJavaVersionString, groovyVersionSupportsAction, isJavaSupportIndy, logPluginClasspath

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

GROOVY_1_6_0_RC2

protected static final Version GROOVY_1_6_0_RC2

Groovy 1.6.0 RC-2 version.

GROOVY_1_6_0_RC1

protected static final Version GROOVY_1_6_0_RC1

Groovy 1.6.0 RC-1 version.

GROOVY_1_5_8

protected static final Version GROOVY_1_5_8

Groovy 1.5.8 version.

GROOVY_1_5_2

protected static final Version GROOVY_1_5_2

Groovy 1.5.2 version.

groovydocOutputDirectory

protected java.io.File groovydocOutputDirectory

The location for the generated API docs.

testGroovydocOutputDirectory

protected java.io.File testGroovydocOutputDirectory

The location for the generated test API docs.

windowTitle

protected java.lang.String windowTitle

The window title.

docTitle

protected java.lang.String docTitle

The page title.

footer

protected java.lang.String footer

The page footer.

header

protected java.lang.String header

The page header.

displayAuthor

protected boolean displayAuthor

Whether to display the author in the generated Groovydoc.

overviewFile

protected java.io.File overviewFile

The HTML file to be used for overview documentation.

stylesheetFile

protected java.io.File stylesheetFile

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

stylesheetEncoding

protected java.lang.String stylesheetEncoding

The encoding of stylesheetFile.

scope

protected java.lang.String scope

The scope to generate Groovydoc for. Should be one of:

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

links

protected java.util.List<Link> links

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

Since:

1.0-beta-2

groovydocJavaSources

protected boolean groovydocJavaSources

Whether to include Java sources in groovydoc generation.

Since:

1.0-beta-2

Constructor Detail

AbstractGroovydocMojo

public AbstractGroovydocMojo()

Method Detail

doGroovydocGeneration

protected void doGroovydocGeneration(org.apache.maven.shared.model.fileset.FileSet[] sourceDirectories,
                                     java.util.List classpath,
                                     java.io.File outputDirectory)
                              throws java.lang.ClassNotFoundException,
                                     java.lang.reflect.InvocationTargetException,
                                     java.lang.IllegalAccessException,
                                     java.lang.InstantiationException,
                                     java.net.MalformedURLException

Generates the Groovydoc for the specified sources.

Parameters:

sourceDirectories - The source directories to generate groovydoc for

classpath - The classpath to use for compilation

outputDirectory - The directory to save the generated groovydoc in

Throws:

java.lang.ClassNotFoundException - when a class needed for groovydoc generation cannot be found

java.lang.InstantiationException - when a class needed for groovydoc generation cannot be instantiated

java.lang.IllegalAccessException - when a method needed for groovydoc generation cannot be accessed

java.lang.reflect.InvocationTargetException - when a reflection invocation needed for groovydoc generation cannot be completed

java.net.MalformedURLException - when a classpath element provides a malformed URL

setupProperties

protected java.util.Properties setupProperties()

Sets up the documentation properties.

Returns:

the documentation properties

setupLinks

protected java.util.List setupLinks()
                             throws java.lang.ClassNotFoundException,
                                    java.lang.reflect.InvocationTargetException,
                                    java.lang.IllegalAccessException,
                                    java.lang.InstantiationException

Sets up the Groovydoc links.

Returns:

the Groovydoc links

Throws:

java.lang.ClassNotFoundException - when a class needed for setting up Groovydoc links cannot be found

java.lang.InstantiationException - when a class needed for setting up Groovydoc links cannot be instantiated

java.lang.IllegalAccessException - when a method needed for setting up Groovydoc links cannot be accessed

java.lang.reflect.InvocationTargetException - when a reflection invocation needed for setting up Groovydoc links cannot be completed

createGroovyDocTool

protected java.lang.Object createGroovyDocTool(java.lang.Class groovyDocToolClass,
                                               java.lang.Class resourceManagerClass,
                                               java.util.Properties docProperties,
                                               java.lang.Object classpathResourceManager,
                                               java.util.List<java.lang.String> sourceDirectories,
                                               GroovyDocTemplateInfo groovyDocTemplateInfo,
                                               java.util.List groovydocLinks)
                                        throws java.lang.reflect.InvocationTargetException,
                                               java.lang.IllegalAccessException,
                                               java.lang.InstantiationException

Instantiates a new GroovyDocTool.

Parameters:

groovyDocToolClass - the GroovyDocTool class

resourceManagerClass - the ResourceManager lass

docProperties - the documentation properties

classpathResourceManager - the ClasspathResourceManager for the GroovyDocTool

sourceDirectories - the source directories for the GroovyDocTool

groovyDocTemplateInfo - the GroovyDocTemplateInfo for the GroovyDocTool

groovydocLinks - the Groovydoc links

Returns:

the GroovyDocTool to use in Groovydoc generation

Throws:

java.lang.InstantiationException - when a class needed for setting up Groovydoc tool cannot be instantiated

java.lang.IllegalAccessException - when a method needed for setting up Groovydoc tool cannot be accessed

java.lang.reflect.InvocationTargetException - when a reflection invocation needed for setting up Groovydoc tool cannot be completed

setupGroovyDocSources

protected java.util.List<java.lang.String> setupGroovyDocSources(org.apache.maven.shared.model.fileset.FileSet[] sourceDirectories,
                                                                 org.apache.maven.shared.model.fileset.util.FileSetManager fileSetManager)

Gets the Groovy sources without the Java sources (since the Java sources don't have Javadoc).

Parameters:

sourceDirectories - the source directories to get the Groovy sources from

fileSetManager - the FileSetmanager to use to get the included files

Returns:

the groovy sources

generateGroovydoc

protected void generateGroovydoc(java.io.File outputDirectory,
                                 java.lang.Class groovyDocToolClass,
                                 java.lang.Class outputToolClass,
                                 java.lang.Object fileOutputTool,
                                 java.util.List<java.lang.String> groovydocSources,
                                 java.lang.Object groovyDocTool)
                          throws java.lang.reflect.InvocationTargetException,
                                 java.lang.IllegalAccessException

Performs the Groovydoc generation.

Parameters:

outputDirectory - the directory to output the Groovydoc to

groovyDocToolClass - the GroovyDocTool class

outputToolClass - the OutputTool class

fileOutputTool - the FileOutputTool to use for Groovydoc generation

groovydocSources - the sources to

groovyDocTool - the GroovyDocTool to use for Groovydoc generation

Throws:

java.lang.IllegalAccessException - when a method needed for Groovydoc generation cannot be accessed

java.lang.reflect.InvocationTargetException - when a reflection invocation needed for Groovydoc generation cannot be completed

copyStylesheet

protected void copyStylesheet(java.io.File outputDirectory)

Copies the stylesheet to the specified output directory.

Parameters:

outputDirectory - The output directory to copy the stylesheet to