Package eu.simuline.m2latex.mojo

Class CfgLatexMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

eu.simuline.m2latex.mojo.AbstractLatexMojo

eu.simuline.m2latex.mojo.CfgLatexMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

DocxMojo, DviMojo, HtmlMojo, OdtMojo, PdfMojo, RtfMojo, TxtMojo

@Mojo(name="cfg",
      defaultPhase=SITE)
public class CfgLatexMojo
extends AbstractLatexMojo

Builds documents in the formats configured in the pom from LaTeX sources for the goal cfg tied to the lifecycle phase site.

Field Summary

Fields inherited from class eu.simuline.m2latex.mojo.AbstractLatexMojo

baseDirectory, latexProcessor, settings, targetDirectory, targetSiteDirectory

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

ROLE

Constructor Summary

Constructors

Constructor	Description
CfgLatexMojo()

Method Summary

Modifier and Type	Method	Description
void	execute()	Invoked by maven executing the plugin.
SortedSet<Target>	getTargetSet()	Returns the set of target.

Methods inherited from class eu.simuline.m2latex.mojo.AbstractLatexMojo

initialize

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

Constructor Detail

CfgLatexMojo

public CfgLatexMojo()

Method Detail

getTargetSet

public SortedSet<Target> getTargetSet()

Description copied from interface: ParameterAdapter

Returns the set of target. FIXME: Better would be Enum set but best a sorted kind of EnumSet The set is an EnumSet and thus in a sense sorted, although not imlementing SortedSet: ***** The iterator returned by the iterator method traverses the elements in their natural order (the order in which the enum constants are declared). TODO: generalize to more than one target.

execute

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

Invoked by maven executing the plugin.

Logging:

• WFU01: Cannot read directory...
• WFU03: cannot close
• EFU05: Cannot delete
• EFU06: Cannot move file
• WPP02: tex file may be latex main file
• WPP03: Skipped processing of files with suffixes ...
• EEX01, EEX02, EEX03, WEX04, WEX05: applications for preprocessing graphic files or processing a latex main file fails.

Throws:

org.apache.maven.plugin.MojoFailureException -

• TSS01 if the tex source directory does either not exist or is not a directory.
• TSS02 if the tex source processing directory does either not exist or is not a directory.
• TSS03 if the output directory exists and is no directory.
• TEX01 if invocation of applications for preprocessing graphic files or processing a latex main file fails
• TFU01 if the target directory that would be returned exists already as a regular file.
• TFU03, TFU04, TFU05, TFU06 if copy of output files to target folder fails. For details see LatexProcessor.create().