org.codehaus.mojo.xml

Class TransformMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.xml.AbstractXmlMojo

org.codehaus.mojo.xml.TransformMojo

All Implemented Interfaces:

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

@Mojo(defaultPhase=GENERATE_RESOURCES,
      name="transform",
      threadSafe=true)
public class TransformMojo
extends AbstractXmlMojo

The TransformMojo is used for transforming a set of files using a common stylesheet.

Nested Class Summary

Nested classes/interfaces inherited from class org.codehaus.mojo.xml.AbstractXmlMojo

AbstractXmlMojo.CatalogHandling

Field Summary

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

ROLE

Constructor Summary

Constructors

Constructor and Description
TransformMojo()

Method Summary

Modifier and Type	Method and Description
void	execute() Called by Maven to run the plugin.
protected long	findLastModified(java.util.List<?> files, boolean oldest)
protected boolean	isUpdToDate(java.util.List<?> dependsFiles, java.util.List<?> producesFiles)
static javax.xml.transform.TransformerFactory	newTransformerFactory(java.lang.String factoryClassName, java.lang.ClassLoader classLoader)

Methods inherited from class org.codehaus.mojo.xml.AbstractXmlMojo

activateProxy, asAbsoluteFile, asFiles, getBasedir, getCatalogHandling, getExcludes, getFileNames, getFiles, getLocator, getProject, getResolver, getResource, isSkipping, passivateProxy, setCatalogs

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

TransformMojo

public TransformMojo()

Method Detail

newTransformerFactory

public static javax.xml.transform.TransformerFactory newTransformerFactory(java.lang.String factoryClassName,
                                                                           java.lang.ClassLoader classLoader)
                                                                    throws java.lang.NoSuchMethodException,
                                                                           java.lang.IllegalAccessException,
                                                                           java.lang.reflect.InvocationTargetException

Throws:

java.lang.NoSuchMethodException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

findLastModified

protected long findLastModified(java.util.List<?> files,
                                boolean oldest)

Parameters:

files - the fileNames or URLs to scan their lastModified timestamp.

oldest - if true, returns the latest modificationDate of all files, otherwise returns the earliest.

Returns:

the older or younger last modification timestamp of all files.

isUpdToDate

protected boolean isUpdToDate(java.util.List<?> dependsFiles,
                              java.util.List<?> producesFiles)

Returns:

true to indicate results are up-to-date, that is, when the latest from input files is earlier than the younger from the output files (meaning no re-execution required).

execute

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

Called by Maven to run the plugin.

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException