com.agilejava.docbkx.maven

Class AbstractEpubMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.agilejava.docbkx.maven.AbstractTransformerMojo

com.agilejava.docbkx.maven.AbstractMojoBase

com.agilejava.docbkx.maven.AbstractEpubMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

DocbkxEpubMojo

public abstract class AbstractEpubMojo
extends AbstractMojoBase

A dedicated base class for plugins generating ePub version 2 output, in order to allow the specific stylesheet chosen to be dependent on the #chunkedOutput property.

Author:

Cedric Pronzato, Brian Richard Jackson

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
AbstractEpubMojo()

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.
void	postProcessResult(File result) Post-processes the file.

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

preProcess

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, 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

AbstractEpubMojo

public AbstractEpubMojo()

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.

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.

postProcessResult

public void postProcessResult(File result)
                       throws org.apache.maven.plugin.MojoExecutionException

Description copied from class: AbstractTransformerMojo

Post-processes the file. (Might be changed in the future to except an XML representation instead of a file, in order to prevent the file from being parsed.)

Overrides:

postProcessResult in class AbstractTransformerMojo

Parameters:

result - An individual result.

Throws:

org.apache.maven.plugin.MojoExecutionException