com.agilejava.docbkx.maven

Class AbstractManpagesMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.agilejava.docbkx.maven.AbstractTransformerMojo

com.agilejava.docbkx.maven.AbstractManpagesMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

DocbkxManpagesMojo

public abstract class AbstractManpagesMojo
extends AbstractTransformerMojo

The base class of a Mojo generating Man documentation.

Author:

Cedric Pronzato

Field Summary

Fields inherited from class com.agilejava.docbkx.maven.AbstractTransformerMojo

catalogs

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractManpagesMojo()

Method Summary

Methods

Modifier and Type	Method and Description
void	adjustTransformer(Transformer transformer, String sourceFilename, File targetFile) The operation to override when it is required to make some adjustments to the Transformer right before it is applied to a certain source file.

Methods inherited from class com.agilejava.docbkx.maven.AbstractTransformerMojo

configure, configureXref, convertBooleanToXsltParam, convertStringToXsltParam, createCatalogManager, createDocumentBuilder, createSource, createTitleXPath, createTransformerBuilder, dumpResolvedXML, execute, executeTasks, getArtifacts, getCustomizationParameters, getDefaultStylesheetLocation, getDefaultStylesheetURL, getEntities, getGeneratedSourceDirectory, getIncludes, getMavenProject, getNonDefaultStylesheetLocation, getNonDefaultStylesheetURL, getPostProcess, getPreProcess, getProperty, getSourceDirectory, getStylesheetLocation, getStylesheetURL, getSystemProperties, getTargetDirectory, getTargetFileExtension, getType, getXIncludeSupported, isShowXslMessages, isSkip, isUseStandardOutput, postProcess, postProcessResult, preProcess, setProperty, setShowXslMessages, setTargetFileExtension, setUseStandardOutput, shouldProcessResult

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

AbstractManpagesMojo

public AbstractManpagesMojo()

Method Detail

adjustTransformer

public void adjustTransformer(Transformer transformer,
                     String sourceFilename,
                     File targetFile)

The operation to override when it is required to make some adjustments to the Transformer right before it is applied to a certain source file. The two parameters provide some context, allowing implementers to respond to specific conditions for specific files. This implementation will set the root.filename property, based on the targetFile's name. It will also set the manifest.in.base.dir to a value different than '0', in order to make sure that the Eclipse files are not getting generated to Maven's basedir, but to the target directory instead.

Overrides:

adjustTransformer in class AbstractTransformerMojo

Parameters:

transformer - The Transformer that must be adjusted.

sourceFilename - The name of the source file that is being transformed.

targetFile - The target File.