org.datanucleus.maven

Class AbstractEnhancerMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.datanucleus.maven.AbstractDataNucleusMojo

org.datanucleus.maven.AbstractEnhancerMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractEnhancerCheckMojo, AbstractEnhancerEnhanceMojo

public abstract class AbstractEnhancerMojo
extends AbstractDataNucleusMojo

Base for all enhancer-based Maven2 goals.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	alwaysDetachable
protected boolean	detachListener
protected boolean	generateConstructor
protected boolean	generatePK
protected boolean	quiet
protected String	useFileListFile

Fields inherited from class org.datanucleus.maven.AbstractDataNucleusMojo

api, fork, ignoreMetaDataForMissingClasses, jdkLogConfiguration, log4jConfiguration, metadataDirectory, metadataExcludes, metadataIncludes, persistenceUnitName, pluginArtifacts, verbose

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractEnhancerMojo()

Method Summary

Modifier and Type	Method and Description
protected boolean	determineUseFileListFile()
protected void	enhance(List pluginArtifacts, List files) Run the DataNucleus Enhancer using the specified input data.
protected void	executeDataNucleusTool(List pluginArtifacts, List files) Method to execute the enhancer using the provided artifacts and input files.
protected String	getToolName() Accessor for the name of the class to be invoked.
protected abstract void	prepareModeSpecificCommandLineArguments(org.codehaus.plexus.util.cli.Commandline cl, List args) Template method that sets up arguments for the enhancer depending upon the mode invoked.

Methods inherited from class org.datanucleus.maven.AbstractDataNucleusMojo

execute, executeCommandLine, executeInJvm, findMetadataFiles, getJdkLogConfiguration, getLog4JConfiguration, getUniqueClasspathElements

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

Field Detail

quiet

protected boolean quiet

alwaysDetachable

protected boolean alwaysDetachable

generatePK

protected boolean generatePK

generateConstructor

protected boolean generateConstructor

detachListener

protected boolean detachListener

useFileListFile

protected String useFileListFile

Constructor Detail

AbstractEnhancerMojo

public AbstractEnhancerMojo()

Method Detail

executeDataNucleusTool

protected void executeDataNucleusTool(List pluginArtifacts,
                                      List files)
                               throws org.codehaus.plexus.util.cli.CommandLineException,
                                      org.apache.maven.plugin.MojoExecutionException

Method to execute the enhancer using the provided artifacts and input files.

Specified by:

executeDataNucleusTool in class AbstractDataNucleusMojo

Parameters:

pluginArtifacts - Artifacts to use in CLASSPATH generation

files - Input files

Throws:

org.codehaus.plexus.util.cli.CommandLineException

org.apache.maven.plugin.MojoExecutionException

enhance

protected void enhance(List pluginArtifacts,
                       List files)
                throws org.codehaus.plexus.util.cli.CommandLineException,
                       org.apache.maven.plugin.MojoExecutionException

Run the DataNucleus Enhancer using the specified input data.

Parameters:

pluginArtifacts - for creating classpath for execution.

files - input file list

Throws:

org.codehaus.plexus.util.cli.CommandLineException - if there was an error invoking the DataNucleus Enhancer.

org.apache.maven.plugin.MojoExecutionException

prepareModeSpecificCommandLineArguments

protected abstract void prepareModeSpecificCommandLineArguments(org.codehaus.plexus.util.cli.Commandline cl,
                                                                List args)

Template method that sets up arguments for the enhancer depending upon the mode invoked. This is expected to be implemented by extensions.

Parameters:

cl - Commandline instance to set up arguments for.

args - Arguments list generated by this call (appended to)

getToolName

protected String getToolName()

Accessor for the name of the class to be invoked.

Specified by:

getToolName in class AbstractDataNucleusMojo

Returns:

Class name for the Enhancer.

determineUseFileListFile

protected boolean determineUseFileListFile()