org.apache.maven.plugin.changes
Class AbstractChangesMojo

java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.apache.maven.plugin.changes.AbstractChangesMojo
All Implemented Interfaces:
ContextEnabled, Mojo
Direct Known Subclasses:
AbstractAnnouncementMojo, ChangesCheckMojo, ChangesValidatorMojo

public abstract class AbstractChangesMojo
extends AbstractMojo

Abstract superclass for announcement mojos.

Since:
2.9
Version:
$Id: AbstractChangesMojo.java 1620206 2014-08-24 22:03:05Z hboutemy $

Field Summary
protected  String basedir
          The current project base directory.
protected  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
AbstractChangesMojo()
           
 
Method Summary
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

@Parameter(defaultValue="${session}",
           readonly=true,
           required=true)
protected MavenSession mavenSession
The Maven Session.

Since:
2.3

runOnlyAtExecutionRoot

@Parameter(property="changes.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.9
Constructor Detail

AbstractChangesMojo

public AbstractChangesMojo()
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


Copyright © 2002–2014 The Apache Software Foundation. All rights reserved.