GenerateReleasePomsPhase (Maven Release Manager 2.5.1 API)

java.lang.Object
- org.codehaus.plexus.logging.AbstractLogEnabled
- - org.apache.maven.shared.release.phase.AbstractReleasePhase
  - - org.apache.maven.shared.release.phase.AbstractReleasePomsPhase
    - - org.apache.maven.shared.release.phase.GenerateReleasePomsPhase

All Implemented Interfaces:

ReleasePhase, org.codehaus.plexus.logging.LogEnabled
```
public class GenerateReleasePomsPhase
extends AbstractReleasePomsPhase
```
Generate release POMs.

Author:

Brett Porter, Mark Hobson

Plexus component:
role:
"org.apache.maven.shared.release.phase.ReleasePhase"
role-hint:
"generate-release-poms"

Field Summary
- Fields inherited from interface org.apache.maven.shared.release.phase.ReleasePhase
  ROLE

Constructor Summary

Constructors
Constructor and Description

GenerateReleasePomsPhase()

Constructors
Constructor and Description
`GenerateReleasePomsPhase()`

Method Summary

Methods
Modifier and Type	Method and Description
`ReleaseResult`	`clean(List<MavenProject> reactorProjects)` Clean up after a phase if it leaves any additional files in the checkout.
`ReleaseResult`	`execute(ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, List<MavenProject> reactorProjects)` Execute the phase.
`protected Map<String,String>`	`getNextVersionMap(ReleaseDescriptor releaseDescriptor)`
`protected Map<String,String>`	`getOriginalVersionMap(ReleaseDescriptor releaseDescriptor, List<MavenProject> reactorProjects)`
`ReleaseResult`	`simulate(ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, List<MavenProject> reactorProjects)` Simulate the phase, but don't make any changes to the project.

Methods inherited from class org.apache.maven.shared.release.phase.AbstractReleasePomsPhase
getScmProvider, getScmRepository

Methods inherited from class org.apache.maven.shared.release.phase.AbstractReleasePhase
execute, getReleaseResultSuccess, getResourceBundle, logDebug, logDebug, logError, logInfo, logWarn, simulate

Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled
enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GenerateReleasePomsPhase
```
public GenerateReleasePomsPhase()
```
- Method Detail
  - execute
```
public ReleaseResult execute(ReleaseDescriptor releaseDescriptor,
                    ReleaseEnvironment releaseEnvironment,
                    List<MavenProject> reactorProjects)
                      throws ReleaseExecutionException,
                             ReleaseFailureException
```
    Description copied from interface: ReleasePhase
    
    Execute the phase.
    
    Parameters:
    releaseDescriptor - the configuration to use
    releaseEnvironment - the environmental configuration, such as Maven settings, Maven home, etc.
    reactorProjects - the reactor projects
    
    Returns:
    the release result
    
    Throws:
    
    ReleaseExecutionException - an exception during the execution of the phase
    
    ReleaseFailureException - a failure during the execution of the phase
  - simulate
```
public ReleaseResult simulate(ReleaseDescriptor releaseDescriptor,
                     ReleaseEnvironment releaseEnvironment,
                     List<MavenProject> reactorProjects)
                       throws ReleaseExecutionException,
                              ReleaseFailureException
```
    Description copied from interface: ReleasePhase
    
    Simulate the phase, but don't make any changes to the project.
    
    Parameters:
    releaseDescriptor - the configuration to use
    releaseEnvironment - the environmental configuration, such as Maven settings, Maven home, etc.
    reactorProjects - the reactor projects
    
    Returns:
    the release result
    
    Throws:
    
    ReleaseExecutionException - an exception during the execution of the phase
    
    ReleaseFailureException - a failure during the execution of the phase
  - getOriginalVersionMap
```
protected Map<String,String> getOriginalVersionMap(ReleaseDescriptor releaseDescriptor,
                                       List<MavenProject> reactorProjects)
```
  - getNextVersionMap
```
protected Map<String,String> getNextVersionMap(ReleaseDescriptor releaseDescriptor)
```
  - clean
```
public ReleaseResult clean(List<MavenProject> reactorProjects)
```
    Description copied from interface: ReleasePhase
    
    Clean up after a phase if it leaves any additional files in the checkout.
    
    Specified by:
    
    clean in interface ReleasePhase
    
    Overrides:
    
    clean in class AbstractReleasePhase
    
    Parameters:
    reactorProjects - the reactor projects
    
    Returns:
    the release result

Class GenerateReleasePomsPhase

Field Summary

Fields inherited from interface org.apache.maven.shared.release.phase.ReleasePhase

Constructor Summary

Method Summary

Methods inherited from class org.apache.maven.shared.release.phase.AbstractReleasePomsPhase

Methods inherited from class org.apache.maven.shared.release.phase.AbstractReleasePhase

Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled

Methods inherited from class java.lang.Object

Constructor Detail

GenerateReleasePomsPhase

Method Detail

execute

simulate

getOriginalVersionMap

getNextVersionMap

clean