org.jomc.mojo
Class AbstractSourcesManageMojo

Package class diagram package AbstractSourcesManageMojo
java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.jomc.mojo.AbstractJomcMojo
          extended by 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 3838 2011-10-08 20:15:41Z schulte2005 $
Author:
Christian Schulte

Field Summary
 
Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE
 
Constructor Summary
AbstractSourcesManageMojo()
          Creates a new AbstractSourcesManageMojo instance.
 
Method Summary
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.


Copyright © 2005-2012 The JOMC Project. All Rights Reserved.Get JOMC at SourceForge.net. Fast, secure and Free Open Source software downloads
Please note that this documentation is maintained by non-native english speaking authors. As such, you may encounter phrases or wordings which seem imprecise or may even have a totally different meaning to native english speaking readers than what the individual author was trying to express. If you are a native english speaking reader and find any such phrases or wordings we kindly ask you to send an email to the corresponding author and help us improve this documentation in order to avoid misunderstandings. You will find the authors' email addresses at the top of each class. Please accept our apologies for any inconvenience caused.