eu.simuline.m2latex.mojo

Class AbstractLatexMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

eu.simuline.m2latex.mojo.AbstractLatexMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

CfgLatexMojo, ChkMojo, ClearMojo, GraphicsMojo

abstract class AbstractLatexMojo
extends org.apache.maven.plugin.AbstractMojo
implements ParameterAdapter

Abstract base class for all mojos.

Field Summary

Fields

Modifier and Type	Field and Description
protected File	baseDirectory The base directory of this maven project.
protected LatexProcessor	latexProcessor
protected Settings	settings Comrpises all parameters for executing this maven plugin.
protected File	targetDirectory The target directory of this maven project.
protected File	targetSiteDirectory The target site directory of this maven project.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractLatexMojo()

Method Summary

Modifier and Type	Method and Description
void	initialize() Sets up the parameters and initializes org.m2latex.core.LatexProcessor.

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 eu.simuline.m2latex.core.ParameterAdapter

getTargetSet

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

execute

Field Detail

baseDirectory

@Parameter(name="baseDirectory",
           defaultValue="${basedir}",
           readonly=true)
protected File baseDirectory

The base directory of this maven project. Reinitializes Settings.baseDirectory via initialize().

targetDirectory

@Parameter(name="targetDirectory",
           defaultValue="${project.build.directory}",
           readonly=true)
protected File targetDirectory

The target directory of this maven project. Reinitializes Settings.targetDirectory via initialize().

targetSiteDirectory

@Parameter(name="targetSiteDirectory",
           defaultValue="${project.reporting.outputDirectory}",
           readonly=true)
protected File targetSiteDirectory

The target site directory of this maven project. Reinitializes Settings.baseDirectory via initialize().

settings

@Parameter(name="settings")
protected Settings settings

Comrpises all parameters for executing this maven plugin. If not set in the pom prior to execution, is set in initialize().

latexProcessor

protected LatexProcessor latexProcessor

Constructor Detail

AbstractLatexMojo

AbstractLatexMojo()

Method Detail

initialize

public void initialize()

Description copied from interface: ParameterAdapter

Sets up the parameters and initializes org.m2latex.core.LatexProcessor.

Specified by:

initialize in interface ParameterAdapter