org.apache.torque.mojo
Class BaseMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.torque.mojo.BaseMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractMorphSingleMojo, AbstractSQLExecutorMojo, AntTaskMojo, MorphDataMojo

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

Mojo essentials. Contains the "skip" logic that is the de facto standard for maven plugins. Contains a number of maven related properties that are common to most mojos. Also sets up logging so that if libraries called by a mojo issue log statements to Jakarta Commons Logging or Log4j, those log messages are shown in maven's output

Field Summary

private String	encoding The encoding to use when reading/writing files.
private boolean	forceMojoExecution Setting this parameter to true will force the execution of this mojo, even if it would get skipped usually.
static String	FS
private org.apache.maven.execution.MavenSession	mavenSession
private org.apache.maven.project.MavenProject	project The Maven project this plugin runs in.
private org.apache.maven.settings.Settings	settings
private boolean	skip When true, skip the execution of this mojo
static String	SKIP_PACKAGING_TYPE
private boolean	startMavenLogger When true, redirect logging from Log4j and Jakarta Commons Logging to the Maven logging system

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

ROLE

Constructor Summary

BaseMojo()

Method Summary

protected void	afterExecution()
protected void	beforeExecution()
void	execute()
protected abstract void	executeMojo()
String	getEncoding()
org.apache.maven.execution.MavenSession	getMavenSession()
org.apache.maven.project.MavenProject	getProject() Returns the maven project.
org.apache.maven.settings.Settings	getSettings()
boolean	isForceMojoExecution()
boolean	isSkip()
boolean	isStartMavenLogger()
void	setEncoding(String encoding)
void	setForceMojoExecution(boolean forceMojoExecution)
void	setMavenSession(org.apache.maven.execution.MavenSession mavenSession)
void	setProject(org.apache.maven.project.MavenProject project)
void	setSettings(org.apache.maven.settings.Settings settings)
void	setSkip(boolean skip)
void	setStartMavenLogger(boolean startMavenLogger)
protected boolean	skipMojo() Determine if the mojo execution should get skipped.

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

FS

public static final String FS

SKIP_PACKAGING_TYPE

public static final String SKIP_PACKAGING_TYPE

See Also:

Constant Field Values

startMavenLogger

private boolean startMavenLogger

When true, redirect logging from Log4j and Jakarta Commons Logging to the Maven logging system

skip

private boolean skip

When true, skip the execution of this mojo

forceMojoExecution

private boolean forceMojoExecution

Setting this parameter to true will force the execution of this mojo, even if it would get skipped usually.

encoding

private String encoding

The encoding to use when reading/writing files. If not specified this defaults to the platform specific encoding of whatever machine the build is running on.

project

private org.apache.maven.project.MavenProject project

The Maven project this plugin runs in.

settings

private org.apache.maven.settings.Settings settings

Since:

1.0

mavenSession

private org.apache.maven.execution.MavenSession mavenSession

Constructor Detail

BaseMojo

public BaseMojo()

Method Detail

beforeExecution

protected void beforeExecution()
                        throws org.apache.maven.plugin.MojoExecutionException,
                               org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

afterExecution

protected void afterExecution()
                       throws org.apache.maven.plugin.MojoExecutionException,
                              org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

executeMojo

protected abstract void executeMojo()
                             throws org.apache.maven.plugin.MojoExecutionException,
                                    org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

skipMojo

protected boolean skipMojo()

Determine if the mojo execution should get skipped.

This is the case if:

• skip is true
• if the mojo gets executed on a project with packaging type 'pom' and forceMojoExecution is false

Returns:

true if the mojo execution should be skipped.

getProject

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

Returns the maven project.

Returns:

The maven project where this plugin runs in.

getEncoding

public String getEncoding()

setEncoding

public void setEncoding(String encoding)

isSkip

public boolean isSkip()

setSkip

public void setSkip(boolean skip)

isForceMojoExecution

public boolean isForceMojoExecution()

setForceMojoExecution

public void setForceMojoExecution(boolean forceMojoExecution)

getSettings

public org.apache.maven.settings.Settings getSettings()

setSettings

public void setSettings(org.apache.maven.settings.Settings settings)

getMavenSession

public org.apache.maven.execution.MavenSession getMavenSession()

setMavenSession

public void setMavenSession(org.apache.maven.execution.MavenSession mavenSession)

setProject

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

isStartMavenLogger

public boolean isStartMavenLogger()

setStartMavenLogger

public void setStartMavenLogger(boolean startMavenLogger)