com.agilejava.docbkx.maven

Class AbstractHtmlMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.agilejava.docbkx.maven.AbstractTransformerMojo

com.agilejava.docbkx.maven.AbstractMojoBase

com.agilejava.docbkx.maven.AbstractHtmlMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

DocbkxHtmlMojo, DocbkxXhtml5Mojo, DocbkxXhtmlMojo

public abstract class AbstractHtmlMojo
extends AbstractMojoBase

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

Author:

Wilfred Springer

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

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	execute() DOCUMENT ME!
protected String	getNonDefaultStylesheetLocation() DOCUMENT ME!

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, executeTasks, getArtifacts, getCustomizationParameters, getDefaultStylesheetLocation, getDefaultStylesheetURL, getEntities, getGeneratedSourceDirectory, getIncludes, getMavenProject, getNonDefaultStylesheetURL, getPostProcess, getPreProcess, getProperty, getSourceDirectory, getStylesheetLocation, getStylesheetURL, getSystemProperties, getTargetDirectory, getTargetFileExtension, getType, getXIncludeSupported, isShowXslMessages, isSkip, isUseStandardOutput, postProcess, postProcessResult, 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

AbstractHtmlMojo

public AbstractHtmlMojo()

Method Detail

getNonDefaultStylesheetLocation

protected String getNonDefaultStylesheetLocation()

DOCUMENT ME!

Overrides:

getNonDefaultStylesheetLocation in class AbstractTransformerMojo

Returns:

DOCUMENT ME!

execute

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

DOCUMENT ME!

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Overrides:

execute in class AbstractTransformerMojo

Throws:

org.apache.maven.plugin.MojoExecutionException - DOCUMENT ME!

org.apache.maven.plugin.MojoFailureException - DOCUMENT ME!

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.