org.jomc.mojo

Class AbstractResourcesWriteMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.jomc.mojo.AbstractJomcMojo

org.jomc.mojo.AbstractResourcesWriteMojo

All Implemented Interfaces:

ContextEnabled, Mojo

Direct Known Subclasses:

MainResourcesWriteMojo, TestResourcesWriteMojo

public abstract class AbstractResourcesWriteMojo
extends AbstractJomcMojo

Base class for writing resource files.

Version:

$JOMC: AbstractResourcesWriteMojo.java 5043 2015-05-27 07:03:39Z schulte $

Author:

Christian Schulte

Field Summary

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

ROLE

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	addMavenResource(MavenProject mavenProject, Resource resource) Adds a resource to a MavenProjecŧ.
protected void	executeTool() Executes this tool.
protected abstract ClassLoader	getResourcesClassLoader() Gets the class loader to use for writing resource files.
protected abstract File	getResourcesDirectory() Gets the directory to write the resource files to.
protected abstract String	getResourcesModuleName() Gets the name of the module to write resource files of.
protected abstract File	getResourcesOutputDirectory() Gets the directory to copy resource files to.

Methods inherited from class org.jomc.mojo.AbstractJomcMojo

assertValidParameters, assertValidResources, createClassFileProcessor, createJomcTool, createModelContext, createObject, createObject, createResourceFileProcessor, createSourceFileProcessor, execute, getAbsoluteFile, getDirectory, getExecutionStrategy, 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

AbstractResourcesWriteMojo

public AbstractResourcesWriteMojo()

Creates a new AbstractResourcesWriteMojo 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.

getResourcesModuleName

protected abstract String getResourcesModuleName()
                                          throws MojoExecutionException

Gets the name of the module to write resource files of.

Returns:

The name of the module to write resource files of.

Throws:

MojoExecutionException - if getting the name fails.

getResourcesClassLoader

protected abstract ClassLoader getResourcesClassLoader()
                                                throws MojoExecutionException

Gets the class loader to use for writing resource files.

Returns:

The class loader to use for writing resource files.

Throws:

MojoExecutionException - if getting the class loader fails.

getResourcesDirectory

protected abstract File getResourcesDirectory()
                                       throws MojoExecutionException

Gets the directory to write the resource files to.

Returns:

The directory to write the resource files to.

Throws:

MojoExecutionException - if getting the directory fails.

getResourcesOutputDirectory

protected abstract File getResourcesOutputDirectory()
                                             throws MojoExecutionException

Gets the directory to copy resource files to.

Returns:

The directory to copy resource files to.

Throws:

MojoExecutionException - if getting the directory fails.

Since:

1.2

addMavenResource

protected abstract void addMavenResource(MavenProject mavenProject,
                    Resource resource)
                                  throws MojoExecutionException

Adds a resource to a MavenProjecŧ.

Parameters:

mavenProject - The MavenProject to add a resource to.

resource - The Resource to add.

Throws:

MojoExecutionException - if adding the resource fails.

Since:

1.2