org.jomc.mojo

Class AbstractSourcesManageMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.jomc.mojo.AbstractJomcMojo

org.jomc.mojo.AbstractSourcesManageMojo

All Implemented Interfaces:

ContextEnabled, Mojo

Direct Known Subclasses:

MainSourcesManageMojo, TestSourcesManageMojo

public abstract class AbstractSourcesManageMojo
extends AbstractJomcMojo

Base class for managing source code files.

Version:

$JOMC: AbstractSourcesManageMojo.java 4613 2012-09-22 10:07:08Z schulte $

Author:

Christian Schulte

Field Summary

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

ROLE

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
protected void	executeTool() Executes this tool.
protected abstract ClassLoader	getSourcesClassLoader() Gets the class loader to use for managing source code files.
protected abstract File	getSourcesDirectory() Gets the directory holding the source code files to manage.
protected abstract String	getSourcesModuleName() Gets the name of the module to manage source code files of.

Methods inherited from class org.jomc.mojo.AbstractJomcMojo

assertValidParameters, assertValidResources, createClassFileProcessor, createJomcTool, createModelContext, createObject, createResourceFileProcessor, createSourceFileProcessor, execute, getAbsoluteFile, getDirectory, getExecutionStrategy, getGoal, getMainClassLoader, getMainClasspathElements, getMavenProject, getMavenSession, getModel, getModel, getModuleName, getOutputDirectory, getProperties, getReportOutputDirectory, getResource, getSessionDirectory, getSourceDirectory, getTestClassLoader, getTestClasspathElements, getTestModuleName, getTestOutputDirectory, getTestSourceDirectory, 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

AbstractSourcesManageMojo

public AbstractSourcesManageMojo()

Creates a new AbstractSourcesManageMojo instance.

Method Detail

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.

getSourcesModuleName

protected abstract String getSourcesModuleName()
                                        throws MojoExecutionException

Gets the name of the module to manage source code files of.

Returns:

The name of the module to manage source code files of.

Throws:

MojoExecutionException - if getting the name fails.

getSourcesClassLoader

protected abstract ClassLoader getSourcesClassLoader()
                                              throws MojoExecutionException

Gets the class loader to use for managing source code files.

Returns:

The class loader to use for managing source code files.

Throws:

MojoExecutionException - if getting the class loader fails.

getSourcesDirectory

protected abstract File getSourcesDirectory()
                                     throws MojoExecutionException

Gets the directory holding the source code files to manage.

Returns:

The directory holding the source code files to manage.

Throws:

MojoExecutionException - if getting the directory fails.