org.jomc.mojo

Class AbstractClassesCommitMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.jomc.mojo.AbstractJomcMojo

org.jomc.mojo.AbstractClassesCommitMojo

All Implemented Interfaces:

ContextEnabled, Mojo

Direct Known Subclasses:

MainClassesCommitMojo, TestClassesCommitMojo

public abstract class AbstractClassesCommitMojo
extends AbstractJomcMojo

Base class for committing model objects to class files.

Version:

$JOMC: AbstractClassesCommitMojo.java 5228 2016-04-24 11:08:06Z schulte $

Author:

Christian Schulte

Field Summary

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractClassesCommitMojo() Creates a new AbstractClassesCommitMojo instance.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	assertValidParameters() Validates the parameters of the goal.
protected void	executeTool() Executes this tool.
protected abstract ClassLoader	getClassesClassLoader() Gets the class loader to use for committing class file model objects.
protected abstract File	getClassesDirectory() Gets the directory holding the class files to commit model objects to.
protected abstract String	getClassesModuleName() Gets the name of the module to commit class file model objects of.
protected List<Transformer>	getTransformers() Deprecated. As of JOMC 1.8, replaced by method getTransformers(org.jomc.modlet.ModelContext). This method will be removed in JOMC 2.0.
protected List<Transformer>	getTransformers(ClassLoader classLoader) Deprecated. As of JOMC 1.2, the dependencies of the project are no longer searched for XSLT documents. Please use method getTransformers(). This method will be removed in version 2.0.
protected List<Transformer>	getTransformers(ModelContext modelContext) Gets transformers to use for transforming model objects.

Methods inherited from class org.jomc.mojo.AbstractJomcMojo

assertValidResources, copyDirectory, copyFile, createClassFileProcessor, createJomcTool, createModelContext, createObject, createObject, createResourceFileProcessor, createSourceFileProcessor, execute, getAbsoluteFile, getDirectory, getExecutionStrategy, getExecutorService, getGoal, getMainClassLoader, getMainClasspathElements, getMavenProject, getMavenSession, getModel, getModel, getModuleName, getOutputDirectory, getProperties, getProperties, getReportOutputDirectory, getResource, getResource, getSessionDirectory, getSourceDirectory, getTestClassLoader, getTestClasspathElements, getTestModuleName, getTestOutputDirectory, getTestSourceDirectory, getTransformer, getTransformer, isClassProcessingEnabled, isExecutionPermitted, isLoggable, isModelObjectClasspathResolutionEnabled, isModelProcessingEnabled, isResourceProcessingEnabled, isSourceProcessingEnabled, isVerbose, log, log, logMissingModule, logProcessingModel, logProcessingModule, logSeparator, logSeparator, logToolSuccess, setClassProcessingEnabled, setModelObjectClasspathResolutionEnabled, setModelProcessingEnabled, setResourceProcessingEnabled, setSourceProcessingEnabled, setupJomcTool, setupModelContext, setVerbose

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

AbstractClassesCommitMojo

public AbstractClassesCommitMojo()

Creates a new AbstractClassesCommitMojo instance.

Method Detail

getTransformers

@Deprecated
protected List<Transformer> getTransformers(ClassLoader classLoader)
                                     throws MojoExecutionException

Deprecated. As of JOMC 1.2, the dependencies of the project are no longer searched for XSLT documents. Please use method getTransformers(). This method will be removed in version 2.0.

Gets transformers to use for transforming model objects.

Parameters:

classLoader - The class loader to use for loading a transformer class path resource.

Returns:

A list of transformers to use for transforming model objects.

Throws:

NullPointerException - if classLoader is null.

MojoExecutionException - if getting the transformers fails.

getTransformers

@Deprecated
protected List<Transformer> getTransformers()
                                     throws MojoExecutionException

Deprecated. As of JOMC 1.8, replaced by method getTransformers(org.jomc.modlet.ModelContext). This method will be removed in JOMC 2.0.

Gets transformers to use for transforming model objects.

Returns:

A list of transformers to use for transforming model objects.

Throws:

MojoExecutionException - if getting the transformers fails.

Since:

1.2

getTransformers

protected List<Transformer> getTransformers(ModelContext modelContext)
                                     throws MojoExecutionException

Gets transformers to use for transforming model objects.

Parameters:

modelContext - The model context to search.

Returns:

A list of transformers to use for transforming model objects.

Throws:

NullPointerException - if modelContext is null.

MojoExecutionException - if getting the transformers fails.

Since:

1.8

assertValidParameters

protected void assertValidParameters()
                              throws MojoFailureException

Description copied from class: AbstractJomcMojo

Validates the parameters of the goal.

Overrides:

assertValidParameters in class AbstractJomcMojo

Throws:

MojoFailureException - if illegal parameter values are detected.

See Also:

AbstractJomcMojo.assertValidResources(java.util.Collection)

executeTool

protected final void executeTool()
                          throws Exception

Description copied from class: AbstractJomcMojo

Executes this tool.

Specified by:

executeTool in class AbstractJomcMojo

Throws:

Exception - if execution of this tool fails.

getClassesModuleName

protected abstract String getClassesModuleName()
                                        throws MojoExecutionException

Gets the name of the module to commit class file model objects of.

Returns:

The name of the module to commit class file model objects of.

Throws:

MojoExecutionException - if getting the name fails.

getClassesClassLoader

protected abstract ClassLoader getClassesClassLoader()
                                              throws MojoExecutionException

Gets the class loader to use for committing class file model objects.

Returns:

The class loader to use for committing class file model objects.

Throws:

MojoExecutionException - if getting the class loader fails.

getClassesDirectory

protected abstract File getClassesDirectory()
                                     throws MojoExecutionException

Gets the directory holding the class files to commit model objects to.

Returns:

The directory holding the class files to commit model objects to.

Throws:

MojoExecutionException - if getting the directory fails.