org.codehaus.modello.maven

Class AbstractModelloGeneratorMojo

Known Direct Subclasses:
ModelloConvertersMojo, ModelloDom4jReaderMojo, ModelloDom4jWriterMojo, ModelloGenerateMojo, ModelloJavaMojo, ModelloJDOMWriterMojo, ModelloJPoxJdoMappingMojo, ModelloJPoxMetadataClassMojo, ModelloJPoxStoreMojo, ModelloPlexusRegistryReaderMojo, ModelloPlexusRegistryWriterMojo, ModelloStaxReaderMojo, ModelloStaxWriterMojo, ModelloXdocMojo, ModelloXpp3ReaderMojo, ModelloXpp3WriterMojo, ModelloXsdMojo

public abstract class AbstractModelloGeneratorMojo
extends AbstractMojo

Version:
$Id: AbstractModelloGeneratorMojo.java 895 2008-05-24 22:31:50Z hboutemy $
Author:
Trygve Laugstøl

Method Summary

protected Properties
createParameters()
Creates a Properties objects.
protected void
customizeParameters(Properties parameters)
Override this method to customize the values in the properties set.
void
execute()
String
getBasedir()
protected abstract String
getGeneratorType()
String
getModel()
Deprecated. Use getModels() instead
ModelloCore
getModelloCore()
String[]
getModels()
abstract File
getOutputDirectory()
boolean
getPackageWithVersion()
MavenProject
getProject()
String
getVersion()
protected boolean
producesCompilableResult()
protected boolean
producesResources()
void
setBasedir(String basedir)
void
setModel(String model)
Deprecated. Use setModels(String[]) instead
void
setModelloCore(ModelloCore modelloCore)
void
setModels(String[] models)
void
setPackageWithVersion(boolean packageWithVersion)
void
setPackagedVersions(List packagedVersions)
void
setProject(MavenProject project)
void
setVersion(String version)

Method Details

createParameters

protected Properties createParameters()
Creates a Properties objects.

The abstract mojo will override the output directory, the version and the package with version flag.

Returns:
the parameters

customizeParameters

protected void customizeParameters(Properties parameters)
Override this method to customize the values in the properties set.

This method will be called after the parameters have been populated with the parameters in the abstract mojo.

Parameters:
parameters - the parameters to customize

execute

public void execute()
            throws MojoExecutionException

getBasedir

public String getBasedir()

getGeneratorType

protected abstract String getGeneratorType()

getModel

public String getModel()

Deprecated. Use getModels() instead


getModelloCore

public ModelloCore getModelloCore()

getModels

public String[] getModels()
Returns:
Returns the paths to the models.

getOutputDirectory

public abstract File getOutputDirectory()

getPackageWithVersion

public boolean getPackageWithVersion()

getProject

public MavenProject getProject()

getVersion

public String getVersion()

producesCompilableResult

protected boolean producesCompilableResult()

producesResources

protected boolean producesResources()

setBasedir

public void setBasedir(String basedir)

setModel

public void setModel(String model)

Deprecated. Use setModels(String[]) instead


setModelloCore

public void setModelloCore(ModelloCore modelloCore)

setModels

public void setModels(String[] models)
Parameters:
models - Sets the paths to the models.

setPackageWithVersion

public void setPackageWithVersion(boolean packageWithVersion)

setPackagedVersions

public void setPackagedVersions(List packagedVersions)

setProject

public void setProject(MavenProject project)

setVersion

public void setVersion(String version)