org.jdtaus.core.container.mojo

Class AbstractContainerMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.jdtaus.core.container.mojo.AbstractContainerMojo

All Implemented Interfaces:

ContextEnabled, Mojo

Direct Known Subclasses:

CleanMojo, JavaContainerMojo, SpringDescriptorMojo, VerifyModelMojo

public abstract class AbstractContainerMojo
extends AbstractMojo

jDTAUS Container Mojo base implementation.

Version:

$JDTAUS: AbstractContainerMojo.java 8743 2012-10-07 03:06:20Z schulte $

Author:

Christian Schulte

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractContainerMojo.SourceEditor Interface to manipulate source files.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String[]	DEFAULT_SOURCE_INCLUDES Default source include patterns.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractContainerMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected static void	disableThreadContextClassLoader() Disables the use of the thread context classloader by setting system property org.jdtaus.core.container.ClassLoaderFactory.enableContextClassloader to true.
protected String	edit(String str, AbstractContainerMojo.SourceEditor editor) Edits a string.
protected static void	enableThreadContextClassLoader() Enables the use of the thread context classloader by setting system property org.jdtaus.core.container.ClassLoaderFactory.enableContextClassloader to true.
protected String	formatComment(String text) Formats a given text to a javadoc comment.
protected Collection	getAllSources() Gets all source files from the project's compile source roots.
protected Set	getClasspathElements() Accessor to the project's classpath elements including runtime dependencies.
protected String	getEncoding() Getter for property encoding.
protected Locale	getLocale() Getter for property locale.
protected MavenProject	getMavenProject() Accessor to the currently executed MavenProject.
protected ModelManager	getModelManager() Gets the ModelManager instance.
protected ClassLoader	getRuntimeClassLoader(ClassLoader parent) Provides access to the project's runtime classpath.
protected File	getSource(List roots, String className) Accessor to a *.java file for a given class name.
protected ClassLoader	getTestClassLoader(ClassLoader parent) Provides access to the project's test classpath.
protected Set	getTestClasspathElements() Accessor to the test classpath elements.
protected Collection	getTestSources() Gets all source files from the project's test compile source roots.
protected VelocityEngine	getVelocity() Gets the VelocityEngine used for generating source code.
protected void	indent(StringBuffer stringBuffer) Adds the configured number of spaces to a string buffer.
protected boolean	isClasspathElementDefaultExlude(String element) Indicates whether a class path element is on the list of default class path element excludes.
protected boolean	isClasspathElementIncluded(String element) Indicates wheter a class path element should be included in the classpath.
protected boolean	isTestClasspathElementIncluded(String element) Indicates wheter a class path element should be included in the classpath.
protected boolean	isTestMode() Getter for property testMode.
protected String	load(File file) Loads the contents of a file.
protected void	save(File file, String str) Saves a string to a file.

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

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

execute

Field Detail

DEFAULT_SOURCE_INCLUDES

protected static final String[] DEFAULT_SOURCE_INCLUDES

Default source include patterns.

Constructor Detail

AbstractContainerMojo

public AbstractContainerMojo()

Method Detail

disableThreadContextClassLoader

protected static void disableThreadContextClassLoader()

Disables the use of the thread context classloader by setting system property org.jdtaus.core.container.ClassLoaderFactory.enableContextClassloader to true.

edit

protected final String edit(String str,
          AbstractContainerMojo.SourceEditor editor)
                     throws MojoFailureException

Edits a string.

Parameters:

str - The string to edit.

editor - The editor to use for editing str.

Returns:

str edited by editor.

Throws:

NullPointerException - if either str or editor is null.

MojoFailureException - for unrecoverable errors.

enableThreadContextClassLoader

protected static void enableThreadContextClassLoader()

Enables the use of the thread context classloader by setting system property org.jdtaus.core.container.ClassLoaderFactory.enableContextClassloader to true.

formatComment

protected String formatComment(String text)

Formats a given text to a javadoc comment.

Parameters:

text - The text to format.

Returns:

text as a javadoc comment.

Throws:

NullPointerException - if text is null.

getAllSources

protected final Collection getAllSources()

Gets all source files from the project's compile source roots.

Returns:

a Collection holding File instances for all source files found in all compile source roots.

getClasspathElements

protected final Set getClasspathElements()
                                  throws org.apache.maven.artifact.DependencyResolutionRequiredException

Accessor to the project's classpath elements including runtime dependencies.

Returns:

a set of class path element strings.

Throws:

org.apache.maven.artifact.DependencyResolutionRequiredException - for any unresolved dependency scopes.

getEncoding

protected final String getEncoding()

Getter for property encoding.

Returns:

the encoding to use for reading and writing sources or null to use the system's default encoding.

getLocale

protected final Locale getLocale()

Getter for property locale.

Returns:

the locale to use for javadoc comments.

getMavenProject

protected final MavenProject getMavenProject()

Accessor to the currently executed MavenProject.

Returns:

the currently executed MavenProject.

getModelManager

protected ModelManager getModelManager()

Gets the ModelManager instance.

Returns:

the ModelManager instance.

getRuntimeClassLoader

protected final ClassLoader getRuntimeClassLoader(ClassLoader parent)
                                           throws MojoFailureException

Provides access to the project's runtime classpath.

Parameters:

parent - the parent classloader to use for the runtime classloader.

Returns:

a ClassLoader initialized with the project's runtime classpath.

Throws:

MojoFailureException - for unrecoverable technical errors.

getSource

protected final File getSource(List roots,
             String className)

Accessor to a *.java file for a given class name.

Parameters:

roots - list of source roots to search.

className - The class name to return the corresponding *.java file for (needs to be in the project's compile source roots). No inner classes are supported yet.

Returns:

the source file for the class with name className or null if no corresponding source file can be found.

Throws:

NullPointerException - if either roots or className is null.

getTestClassLoader

protected final ClassLoader getTestClassLoader(ClassLoader parent)
                                        throws MojoFailureException

Provides access to the project's test classpath.

Parameters:

parent - the parent classloader to use for the test classloader.

Returns:

a ClassLoader initialized with the project's test classpath.

Throws:

MojoFailureException - for unrecoverable technical errors.

getTestClasspathElements

protected final Set getTestClasspathElements()
                                      throws org.apache.maven.artifact.DependencyResolutionRequiredException

Accessor to the test classpath elements.

Returns:

a set of class path element strings.

Throws:

org.apache.maven.artifact.DependencyResolutionRequiredException - for any unresolved dependency scopes.

getTestSources

protected final Collection getTestSources()

Gets all source files from the project's test compile source roots.

Returns:

a Collection holding File instances for all source files found in all test compile source roots.

getVelocity

protected final VelocityEngine getVelocity()
                                    throws Exception

Gets the VelocityEngine used for generating source code.

Returns:

the VelocityEngine used for generating source code.

Throws:

Exception - if initializing a new velocity engine fails.

indent

protected final void indent(StringBuffer stringBuffer)

Adds the configured number of spaces to a string buffer.

Parameters:

stringBuffer - The StringBuffer to add the number of spaces to.

Throws:

NullPointerException - if stringBuffer is null.

isClasspathElementDefaultExlude

protected boolean isClasspathElementDefaultExlude(String element)

Indicates whether a class path element is on the list of default class path element excludes.

Parameters:

element - the element to check for default classpath exclusion.

Returns:

true if element should be excluded by default; false if not.

Throws:

NullPointerException - if element is null.

isClasspathElementIncluded

protected boolean isClasspathElementIncluded(String element)

Indicates wheter a class path element should be included in the classpath.

Parameters:

element - the element to check for classpath inclusion.

Returns:

true if element should be included in the classpath; false if not.

Throws:

NullPointerException - if element is null.

isTestClasspathElementIncluded

protected boolean isTestClasspathElementIncluded(String element)

Indicates wheter a class path element should be included in the classpath.

Parameters:

element - the element to check for classpath inclusion.

Returns:

true if element should be included in the classpath; false if not.

Throws:

NullPointerException - if element is null.

isTestMode

protected final boolean isTestMode()

Getter for property testMode.

Returns:

true if no sources will be touched; false if sources will be changed.

load

protected final String load(File file)
                     throws MojoFailureException

Loads the contents of a file.

Parameters:

file - The file to load.

Returns:

the contents of file.

Throws:

NullPointerException - if file is null.

MojoFailureException - for unrecoverable errors.

save

protected final void save(File file,
        String str)
                   throws MojoFailureException

Saves a string to a file.

Parameters:

file - The file to save str to.

str - The string to save to file.

Throws:

NullPointerException - if either file or str is null.

MojoFailureException - for unrecoverable errors.