org.andromda.maven.plugin.configuration

Class AbstractConfigurationMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.andromda.maven.plugin.configuration.AbstractConfigurationMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

public abstract class AbstractConfigurationMojo
extends org.apache.maven.plugin.AbstractMojo

An abstract Mojo for dealing with the AndroMDA configuration, if a plugin needs to use the AndroMDA configuration, it should extend this class.

Author:

Chad Brandon, Bob Fields

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	skip Set this to 'true' to bypass cartridge tests entirely.
protected boolean	skipTests Set this to 'true' to skip running tests, but still compile them.
protected boolean	testFailureIgnore Set this to true to ignore a failure during testing.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractConfigurationMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addPluginDependencies(String pluginArtifactId, String scope) Adds any dependencies to the current project from the plugin having the given pluginArtifactId.
protected Configuration	getConfiguration(URL configurationUri) Creates the Configuration instance from the URL
protected abstract org.apache.maven.artifact.factory.ArtifactFactory	getFactory() Gets the artifact factory used to construct any new required artifacts.
protected abstract ArtifactRepository	getLocalRepository() Gets the current local repository instance.
protected abstract List<Plugin>	getPlugins() Gets the current project's registered plugin implementations.
protected abstract org.apache.maven.project.MavenProject	getProject() Gets the current project.
protected Properties	getProperties() Collects and returns all properties as a Properties instance.
protected abstract List<String>	getPropertyFiles() Gets the property files for the profile (the ones defined in the filters section of the POM).
protected abstract Settings	getSettings() Gets the current settings of the project.
protected void	initializeClasspathFromClassPathElements(List<String> classpathFiles) Sets the current context class loader from the given runtime classpath elements.
protected String	replaceProperties(String string) Replaces all properties having the style ${some.property} with the value of the specified property if there is one.

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

skip

protected boolean skip

Set this to 'true' to bypass cartridge tests entirely. Its use is NOT RECOMMENDED, but quite convenient on occasion.

skipTests

protected boolean skipTests

Set this to 'true' to skip running tests, but still compile them. Its use is NOT RECOMMENDED, but quite convenient on occasion.

testFailureIgnore

protected boolean testFailureIgnore

Set this to true to ignore a failure during testing. Its use is NOT RECOMMENDED, but quite convenient on occasion.

Constructor Detail

AbstractConfigurationMojo

public AbstractConfigurationMojo()

Method Detail

getConfiguration

protected Configuration getConfiguration(URL configurationUri)
                                  throws IOException

Creates the Configuration instance from the URL

Parameters:

configurationUri -

Returns:

the configuration instance

Throws:

IOException - if the URL is invalid.

getProperties

protected Properties getProperties()
                            throws IOException

Collects and returns all properties as a Properties instance.

Returns:

the properties including those from the project, settings, etc.

Throws:

IOException

replaceProperties

protected String replaceProperties(String string)
                            throws IOException

Replaces all properties having the style ${some.property} with the value of the specified property if there is one.

Parameters:

string - the string to perform replacement on.

Returns:

this.replaceProperties(this.getProperties(),string);

Throws:

IOException

initializeClasspathFromClassPathElements

protected void initializeClasspathFromClassPathElements(List<String> classpathFiles)
                                                 throws MalformedURLException

Sets the current context class loader from the given runtime classpath elements.

Parameters:

classpathFiles -

Throws:

MalformedURLException

addPluginDependencies

protected void addPluginDependencies(String pluginArtifactId,
                         String scope)

Adds any dependencies to the current project from the plugin having the given pluginArtifactId.

Parameters:

pluginArtifactId - the artifactId of the plugin of which to add its dependencies.

scope - the artifact scope in which to add them (runtime, compile, etc).

getProject

protected abstract org.apache.maven.project.MavenProject getProject()

Gets the current project.

Returns:

Returns the project.

getPropertyFiles

protected abstract List<String> getPropertyFiles()

Gets the property files for the profile (the ones defined in the filters section of the POM).

Returns:

Returns the propertyFiles.

getSettings

protected abstract Settings getSettings()

Gets the current settings of the project.

Returns:

Returns the settings.

getFactory

protected abstract org.apache.maven.artifact.factory.ArtifactFactory getFactory()

Gets the artifact factory used to construct any new required artifacts.

Returns:

ArtifactFactory

getPlugins

protected abstract List<Plugin> getPlugins()

Gets the current project's registered plugin implementations.

Returns:

pluginList

getLocalRepository

protected abstract ArtifactRepository getLocalRepository()

Gets the current local repository instance.

Returns:

the local repository instance of the current project.