org.apache.maven.plugin.announcement

Class AbstractAnnouncementMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugin.announcement.AbstractAnnouncementMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AnnouncementMailMojo, AnnouncementMojo

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

Abstract superclass for announcement mojos.

Since:

2.3

Version:

$Id: AbstractAnnouncementMojo.java 1355880 2012-07-01 13:13:15Z olamy $

Field Summary

Fields

Modifier and Type	Field and Description
protected String	basedir The current project base directory.
protected org.apache.maven.execution.MavenSession	mavenSession The Maven Session.
protected boolean	runOnlyAtExecutionRoot This will cause the execution to be run only at the top of a given module tree.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractAnnouncementMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	isThisTheExecutionRoot() Returns true if the current project is located at the Execution Root Directory (where mvn was launched).

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

basedir

@Parameter(property="basedir",
           required=true)
protected String basedir

The current project base directory.

Since:

2.1

mavenSession

@Component
protected org.apache.maven.execution.MavenSession mavenSession

The Maven Session.

Since:

2.3

runOnlyAtExecutionRoot

@Parameter(property="announcement.runOnlyAtExecutionRoot",
           defaultValue="false")
protected boolean runOnlyAtExecutionRoot

This will cause the execution to be run only at the top of a given module tree. That is, run in the project contained in the same folder where the mvn execution was launched.

Since:

2.3

Constructor Detail

AbstractAnnouncementMojo

public AbstractAnnouncementMojo()

Method Detail

isThisTheExecutionRoot

protected boolean isThisTheExecutionRoot()

Returns true if the current project is located at the Execution Root Directory (where mvn was launched).

Returns:

true if the current project is at the Execution Root