org.andromda.maven.plugin

Class AbstractAndroMDAMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.andromda.maven.plugin.configuration.AbstractConfigurationMojo

org.andromda.maven.plugin.AbstractAndroMDAMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AndroMDAMojo, AndroMDAServerStartMojo, AndroMDAServerStopMojo, MagicDrawExportEMFXMIMojo

public abstract class AbstractAndroMDAMojo
extends AbstractConfigurationMojo

The abstract AndroMDA Mojo. This should be extended by the Mojos that are used to run AndroMDA.

Author:

Chad Brandon

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	allowMultipleRuns Do we allow the code generation to run multiple times? Yes for AndroMDA server, no for all other cases unless overridden.
protected String	configurationUri This is the URI to the AndroMDA configuration file.
protected org.apache.maven.artifact.factory.ArtifactFactory	factory
protected ArtifactRepository	localRepository
protected List<org.apache.maven.model.Plugin>	plugins The registered plugin implementations.
protected org.apache.maven.project.MavenProject	project
protected List<String>	propertyFiles
protected Settings	settings The current user system settings for use in Maven.

Fields inherited from class org.andromda.maven.plugin.configuration.AbstractConfigurationMojo

skip, skipTests, testFailureIgnore

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractAndroMDAMojo()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() Initialize configuration and execute plugin
protected abstract void	execute(Configuration configuration) Performs the execution of an AndroMDA service with the given configuration.
protected org.apache.maven.artifact.factory.ArtifactFactory	getFactory()
protected ArtifactRepository	getLocalRepository()
protected List<org.apache.maven.model.Plugin>	getPlugins()
protected org.apache.maven.project.MavenProject	getProject()
protected List<String>	getPropertyFiles()
protected Settings	getSettings()
void	setConfigurationUri(String configurationUri)
void	setProject(org.apache.maven.project.MavenProject project)
void	setPropertyFiles(List<String> propertyFiles) Sets the property files for this project.
void	setSettings(Settings settings) Sets the current settings for this Mojo.

Methods inherited from class org.andromda.maven.plugin.configuration.AbstractConfigurationMojo

addPluginDependencies, getConfiguration, getProperties, initializeClasspathFromClassPathElements, replaceProperties

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

Field Detail

configurationUri

protected String configurationUri

This is the URI to the AndroMDA configuration file.

allowMultipleRuns

protected boolean allowMultipleRuns

Do we allow the code generation to run multiple times? Yes for AndroMDA server, no for all other cases unless overridden. This prevents multiple code generation runs while creating site documentation, generate-sources phase can run more than 8 times for each model when initiated by many of the reporting plugins.

project

protected org.apache.maven.project.MavenProject project

propertyFiles

protected List<String> propertyFiles

settings

protected Settings settings

The current user system settings for use in Maven. (allows us to pass the user settings to the AndroMDA configuration).

factory

protected org.apache.maven.artifact.factory.ArtifactFactory factory

plugins

protected List<org.apache.maven.model.Plugin> plugins

The registered plugin implementations.

localRepository

protected ArtifactRepository localRepository

Constructor Detail

AbstractAndroMDAMojo

public AbstractAndroMDAMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Initialize configuration and execute plugin

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

See Also:

Mojo.execute()

execute

protected abstract void execute(Configuration configuration)
                         throws Exception

Performs the execution of an AndroMDA service with the given configuration.

Parameters:

configuration - the configuration to use for AndroMDA service execution

Throws:

Exception

setConfigurationUri

public void setConfigurationUri(String configurationUri)

Parameters:

configurationUri - The configurationUri to set.

setProject

public void setProject(org.apache.maven.project.MavenProject project)

Parameters:

project - The project to set.

setSettings

public void setSettings(Settings settings)

Sets the current settings for this Mojo.

Parameters:

settings - The settings to set.

setPropertyFiles

public void setPropertyFiles(List<String> propertyFiles)

Sets the property files for this project.

Parameters:

propertyFiles -

getProject

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

Specified by:

getProject in class AbstractConfigurationMojo

See Also:

AbstractConfigurationMojo.getProject()

getPropertyFiles

protected List<String> getPropertyFiles()

Specified by:

getPropertyFiles in class AbstractConfigurationMojo

See Also:

AbstractConfigurationMojo.getPropertyFiles()

getSettings

protected Settings getSettings()

Specified by:

getSettings in class AbstractConfigurationMojo

See Also:

AbstractConfigurationMojo.getSettings()

getFactory

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

Specified by:

getFactory in class AbstractConfigurationMojo

See Also:

AbstractConfigurationMojo.getFactory()

getPlugins

protected List<org.apache.maven.model.Plugin> getPlugins()

Specified by:

getPlugins in class AbstractConfigurationMojo

See Also:

AbstractConfigurationMojo.getPlugins()

getLocalRepository

protected ArtifactRepository getLocalRepository()

Specified by:

getLocalRepository in class AbstractConfigurationMojo

See Also:

AbstractConfigurationMojo.getLocalRepository()