org.tobarsegais.maven

Class AbstractGenerateMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.tobarsegais.maven.AbstractGenerateMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

GenerateBundleMojo, GeneratePDFMojo

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

Field Summary

Fields

Modifier and Type	Field and Description
protected File	bundle
protected org.apache.maven.doxia.Doxia	doxia
protected File	outputDirectory
protected String	outputEncoding The character encoding scheme to be applied when writing output files.
protected org.apache.maven.project.MavenProject	project
protected org.apache.maven.project.MavenProjectHelper	projectHelper
protected boolean	skip Skip compilation.
protected File	sourceDirectory
protected String	sourceEncoding The character encoding scheme to be applied when reading source files.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractGenerateMojo()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute()
org.apache.maven.doxia.document.DocumentCover	getDocumentCover(BundleModel bundleModel, Date date)
org.apache.maven.doxia.document.DocumentMeta	getDocumentMeta(BundleModel bundleModel, Date date)
protected abstract File	getOutputFile()
String	getProjectName()
protected abstract org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer	getRenderer()
protected abstract void	render(org.apache.maven.doxia.document.DocumentModel model)

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

bundle

@Parameter(defaultValue="${basedir/src/docs/bundle.xml}")
protected File bundle

sourceDirectory

@Parameter(defaultValue="${basedir}/src/docs")
protected File sourceDirectory

outputDirectory

@Parameter(defaultValue="${project.build.outputDirectory}")
protected File outputDirectory

skip

@Parameter(property="tobairsegais.skip",
           defaultValue="false")
protected boolean skip

Skip compilation.

sourceEncoding

@Parameter(defaultValue="${project.build.sourceEncoding}")
protected String sourceEncoding

The character encoding scheme to be applied when reading source files.

outputEncoding

@Parameter(defaultValue="${project.build.outputEncoding}")
protected String outputEncoding

The character encoding scheme to be applied when writing output files.

project

@Component
protected org.apache.maven.project.MavenProject project

projectHelper

@Component
protected org.apache.maven.project.MavenProjectHelper projectHelper

doxia

@Component
protected org.apache.maven.doxia.Doxia doxia

Constructor Detail

AbstractGenerateMojo

public AbstractGenerateMojo()

Method Detail

getDocumentCover

public org.apache.maven.doxia.document.DocumentCover getDocumentCover(BundleModel bundleModel,
                                                             Date date)

getDocumentMeta

public org.apache.maven.doxia.document.DocumentMeta getDocumentMeta(BundleModel bundleModel,
                                                           Date date)

getProjectName

public String getProjectName()

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

getRenderer

protected abstract org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer getRenderer()

getOutputFile

protected abstract File getOutputFile()

render

protected abstract void render(org.apache.maven.doxia.document.DocumentModel model)
                        throws org.apache.maven.doxia.docrenderer.DocumentRendererException,
                               IOException

Throws:

org.apache.maven.doxia.docrenderer.DocumentRendererException

IOException