org.codehaus.mojo.appfuse.mojo
Class MojoBase

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.codehaus.mojo.appfuse.mojo.MojoBase

All Implemented Interfaces:

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

Direct Known Subclasses:

CopyDaoFilesMojo, CopyMojoBase, DbToXMLMojo, PojoMojoBase

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

This class is a base class for all appfuse plugin components to use for access to shared resources.

Version:

$Id$

Author:

Scott Ryan

Field Summary

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

ROLE

Constructor Summary

MojoBase()

Method Summary

void	execute() This method will run an appfuse mojo.
java.lang.String	getBasePackageName() Getter for property base package name.
boolean	getCopyOverWrite() Getter for property copy overwrite flag.
java.lang.String	getFilePattern() Getter for property file pattern.
java.lang.String	getModelDirectory() Getter for property model directory.
protected java.lang.String	getModelPackageName() This method will return the full package name to be used for generating output for the model objects.
java.lang.String	getMojoName() Getter for property mojoName.
java.lang.String	getOutputDirectory() Getter for property output directory.
java.util.Properties	getProcessingProperties() Getter for property processing properties.
java.lang.String	getSourceDirectory() Getter for property source directory.
void	setBasePackageName(java.lang.String inBasePackageName) Setter for the base package name.
void	setCopyOverWrite(boolean inCopyOverWrite) Setter for the copy overwrite flag.
void	setFilePattern(java.lang.String inFilePattern) Setter for the file pattern.
void	setModelDirectory(java.lang.String inModelDirectory) Setter for the model directory.
void	setMojoName(java.lang.String inMojoName) Setter for the mojo name.
void	setOutputDirectory(java.lang.String inOutputDirectory) Setter for the output directory.
void	setProcessingProperties(java.util.Properties inProcessingProperties) Setter for the processing properties.
void	setSourceDirectory(java.lang.String inSourceDirectory) Setter for the source directory.
java.lang.String	toString() toString methode: creates a String representation of the object

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, wait, wait, wait

Constructor Detail

MojoBase

public MojoBase()

Method Detail

execute

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

This method will run an appfuse mojo.

Throws:

org.apache.maven.plugin.MojoExecutionException - Thrown if we fail to obtain an appfuse resource.

getBasePackageName

public java.lang.String getBasePackageName()

Getter for property base package name.

Returns:

The value of base package name.

setBasePackageName

public void setBasePackageName(java.lang.String inBasePackageName)

Setter for the base package name.

Parameters:

inBasePackageName - The value of base package name.

getOutputDirectory

public java.lang.String getOutputDirectory()

Getter for property output directory.

Returns:

The value of output directory.

setOutputDirectory

public void setOutputDirectory(java.lang.String inOutputDirectory)

Setter for the output directory.

Parameters:

inOutputDirectory - The value of output directory.

getFilePattern

public java.lang.String getFilePattern()

Getter for property file pattern.

Returns:

The value of file pattern.

setFilePattern

public void setFilePattern(java.lang.String inFilePattern)

Setter for the file pattern.

Parameters:

inFilePatterns - The value of file pattern.

getCopyOverWrite

public boolean getCopyOverWrite()

Getter for property copy overwrite flag.

Returns:

The value of the copy overwrite flag.

setCopyOverWrite

public void setCopyOverWrite(boolean inCopyOverWrite)

Setter for the copy overwrite flag.

Parameters:

inCopyOverWrite - The value of the copy overwrite flag.

getMojoName

public java.lang.String getMojoName()

Getter for property mojoName.

Returns:

The value of the mojo name.

setMojoName

public void setMojoName(java.lang.String inMojoName)

Setter for the mojo name.

Parameters:

inMojoName - The value of the mojo name.

getSourceDirectory

public java.lang.String getSourceDirectory()

Getter for property source directory.

Returns:

The value of source directory.

setSourceDirectory

public void setSourceDirectory(java.lang.String inSourceDirectory)

Setter for the source directory.

Parameters:

inSourceDirectory - The value of source directory.

getModelDirectory

public java.lang.String getModelDirectory()

Getter for property model directory.

Returns:

The value of model directory.

setModelDirectory

public void setModelDirectory(java.lang.String inModelDirectory)

Setter for the model directory.

Parameters:

inModelDirectory - The value of model directory.

getProcessingProperties

public java.util.Properties getProcessingProperties()

Getter for property processing properties.

Returns:

The value of processing properties.

setProcessingProperties

public void setProcessingProperties(java.util.Properties inProcessingProperties)

Setter for the processing properties.

Parameters:

inProcessingProperties - The value of processing properties.

getModelPackageName

protected java.lang.String getModelPackageName()

This method will return the full package name to be used for generating output for the model objects.

Returns:

The full package name for all model objects.

toString

public java.lang.String toString()

toString methode: creates a String representation of the object

Overrides:

toString in class java.lang.Object

Returns:

the String representation