PrepareReleaseMojo (Maven Release Plugin 2.4.2 API)

java.lang.Object
- org.apache.maven.plugin.AbstractMojo
- - org.apache.maven.plugins.release.AbstractReleaseMojo
  - - org.apache.maven.plugins.release.AbstractScmReleaseMojo
    - - org.apache.maven.plugins.release.PrepareReleaseMojo

All Implemented Interfaces:

ContextEnabled, Mojo

Direct Known Subclasses:

PrepareWithPomReleaseMojo
```
@Mojo(name="prepare",
      aggregator=true)
public class PrepareReleaseMojo
extends AbstractScmReleaseMojo
```
Prepare for a release in SCM. Steps through several phases to ensure the POM is ready to be released and then prepares SCM to eventually contain a tagged version of the release and a record in the local copy of the parameters used. This can be followed by a call to release:perform. For more info see http://maven.apache.org/plugins/maven-release-plugin/examples/prepare-release.html.

Version:

$Id: PrepareReleaseMojo.java 1389085 2012-09-23 15:50:37Z rfscholte $

Author:

John Casey, Emmanuel Venisse, Jason van Zyl, Brett Porter

- Field Summary
  - Fields inherited from class org.apache.maven.plugins.release.AbstractReleaseMojo
    project, releaseManager, session
  - Fields inherited from interface org.apache.maven.plugin.Mojo
    ROLE
- Constructor Summary
  
  Constructors
  Constructor and Description
  
  PrepareReleaseMojo()
- Method Summary
  
  Methods
  Modifier and Type Method and Description
  
  void execute()
  
  protected void prepareRelease(boolean generateReleasePoms)
  - Methods inherited from class org.apache.maven.plugins.release.AbstractScmReleaseMojo
    createReleaseDescriptor
  - Methods inherited from class org.apache.maven.plugins.release.AbstractReleaseMojo
    addArgument, getAdditionalProfiles, getBasedir, getReactorProjects, getReleaseEnvironment, mergeCommandLineConfig, setBasedir
  - 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

Constructors
Constructor and Description
`PrepareReleaseMojo()`

Methods
Modifier and Type	Method and Description
`void`	`execute()`
`protected void`	`prepareRelease(boolean generateReleasePoms)`

Constructor Detail
- PrepareReleaseMojo
```
public PrepareReleaseMojo()
```

Method Detail

execute
```
public void execute()
             throws MojoExecutionException,
                    MojoFailureException
```
Specified by:

execute in interface Mojo

Overrides:

execute in class AbstractScmReleaseMojo

Throws:

MojoExecutionException

MojoFailureException

prepareRelease

protected void prepareRelease(boolean generateReleasePoms)
                       throws MojoExecutionException,
                              MojoFailureException

Throws:: MojoExecutionException; MojoFailureException

Class PrepareReleaseMojo

Field Summary

Fields inherited from class org.apache.maven.plugins.release.AbstractReleaseMojo

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

Constructor Summary

Method Summary

Methods inherited from class org.apache.maven.plugins.release.AbstractScmReleaseMojo

Methods inherited from class org.apache.maven.plugins.release.AbstractReleaseMojo

Methods inherited from class org.apache.maven.plugin.AbstractMojo

Methods inherited from class java.lang.Object

Constructor Detail

PrepareReleaseMojo

Method Detail

execute

prepareRelease