de.smartics.maven.exceptions.sdoccode
Class AbstractSdocCodeMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      de.smartics.maven.exceptions.sdoccode.AbstractSdocCodeMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

CopySdocCodeMojo, ExportSdocCodeMojo

public abstract class AbstractSdocCodeMojo
     
     

      
      extends org.apache.maven.plugin.AbstractMojo
     
     

Base implementation to generate SDoc documentation files.

Author:

Robert Reiner

Field Summary

protected String	locale The locale to use regardless of the report.
protected File	output The file to write to.
protected ArrayList	pluginArtifacts The plugin's dependencies to build the classpath for tools to be called.
protected org.apache.maven.project.MavenProject	project The Maven project.
protected boolean	skip A simple flag to skip the generation of the XML files.

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

ROLE

Constructor Summary

AbstractSdocCodeMojo()

Method Summary

void	execute()
org.apache.maven.project.MavenProject	getProject() Returns the maven project.
protected abstract void	handleGeneratedDocuments() Handles the generated documents.
void	setProject(org.apache.maven.project.MavenProject project) Sets the maven project.

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

project

protected org.apache.maven.project.MavenProject project

The Maven project.

Since:

1.0

maven-parameter:

expression="${project}"

maven-readonly:

maven-required:

pluginArtifacts

protected ArrayList pluginArtifacts

The plugin's dependencies to build the classpath for tools to be called.

maven-parameter:

expression="${plugin.artifacts}"

maven-readonly:

maven-required:

skip

protected boolean skip

A simple flag to skip the generation of the XML files. If set on the command line use -Dsdoccode.skip.

Since:

1.0

maven-parameter:

expression="${sdoccode.skip}" default-value="false"

locale

protected String locale

The locale to use regardless of the report. This should be set to the locale the Javadoc comment is written in. If not set, the Maven provided locale is used.

Since:

1.0

maven-parameter:

expression="${sdoccode.locale}"

output

protected File output

The file to write to.

Since:

1.0

Constructor Detail

AbstractSdocCodeMojo

public AbstractSdocCodeMojo()

Method Detail

getProject

public org.apache.maven.project.MavenProject getProject()

Returns the maven project.

Returns:

the maven project.

setProject

public void setProject(org.apache.maven.project.MavenProject project)

Sets the maven project.

Parameters:

project - the maven project.

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

handleGeneratedDocuments

protected abstract void handleGeneratedDocuments()
                                          throws org.apache.maven.plugin.MojoExecutionException,
                                                 org.apache.maven.plugin.MojoFailureException

Handles the generated documents.

Throws:

org.apache.maven.plugin.MojoExecutionException - if the execution encounters a problem.

org.apache.maven.plugin.MojoFailureException - if the mojo fails.