de.oscillation.maven.doxygen

Class AbstractDoxygenMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

de.oscillation.maven.doxygen.AbstractDoxygenMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

DoxygenCleanMojo, DoxygenGenerateMojo

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

Abstract Mojo for Doxygen Mojos.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	outputBasePath The base path for Doxygen output files.
protected List<DoxygenOutputGenerator>	outputGenerators List of all available Doxygen output generators.
protected StringWriter	stringWriter String writer for console output.
protected org.codehaus.plexus.util.cli.StreamConsumer	systemErr Stream consumer for stderr.
protected org.codehaus.plexus.util.cli.StreamConsumer	systemOut Stream consumer for stdout.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractDoxygenMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkExecutable() Checks if calling the Doxygen executable works.
protected void	ensureDoxyfile() Checks if the Doxygen configuration file exists.
void	execute() Checks the Doxygen executable, generates the Doxyfile if necessary and parses relevant parameters from it.
String	getDoxyfilePath()
String	getExecutablePath()
File	getWorkingDirectory()
protected abstract void	performTasks() All goal specific tasks are performed in this function, which is called by execute().
protected void	readOutputParametersFromDoxyfile() Parses the Doxygen configuration file and extracts information on output generators.
boolean	shouldAutogen()

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

Field Detail

stringWriter

protected StringWriter stringWriter

String writer for console output.

systemOut

protected org.codehaus.plexus.util.cli.StreamConsumer systemOut

Stream consumer for stdout.

systemErr

protected org.codehaus.plexus.util.cli.StreamConsumer systemErr

Stream consumer for stderr.

outputBasePath

protected String outputBasePath

The base path for Doxygen output files.

outputGenerators

protected List<DoxygenOutputGenerator> outputGenerators

List of all available Doxygen output generators.

Constructor Detail

AbstractDoxygenMojo

public AbstractDoxygenMojo()

Method Detail

checkExecutable

protected void checkExecutable()

Checks if calling the Doxygen executable works.

ensureDoxyfile

protected void ensureDoxyfile()

Checks if the Doxygen configuration file exists. If it does not exist and the autogen flag was set in pom.xml, the file is automatically generated. Otherwise the execution is aborted with an error message.

readOutputParametersFromDoxyfile

protected void readOutputParametersFromDoxyfile()

Parses the Doxygen configuration file and extracts information on output generators. The information is stored in outputBasePath and outputGenerators.

performTasks

protected abstract void performTasks()

All goal specific tasks are performed in this function, which is called by execute().

execute

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

Checks the Doxygen executable, generates the Doxyfile if necessary and parses relevant parameters from it. Calls performTasks() after the initialization.

Throws:

org.apache.maven.plugin.MojoExecutionException

See Also:

Mojo.execute()

shouldAutogen

public boolean shouldAutogen()

Returns:

true if the autogen flag is set

getDoxyfilePath

public String getDoxyfilePath()

Returns:

the doxyfile path

getExecutablePath

public String getExecutablePath()

Returns:

the executable path

getWorkingDirectory

public File getWorkingDirectory()

Returns:

the workingDirectory