Package org.apache.maven.shared.release.phase

Class CheckPomPhase

java.lang.Object

org.codehaus.plexus.logging.AbstractLogEnabled

org.apache.maven.shared.release.phase.AbstractReleasePhase

org.apache.maven.shared.release.phase.CheckPomPhase

All Implemented Interfaces:

ReleasePhase, org.codehaus.plexus.logging.LogEnabled

public class CheckPomPhase
extends AbstractReleasePhase

Phase that checks the validity of the POM before release.

Field Summary

Fields

Modifier and Type	Field	Description
private ScmRepositoryConfigurator	scmRepositoryConfigurator
private boolean	scmRequired
private boolean	snapshotsRequired

Constructor Summary

Constructors

Constructor	Description
CheckPomPhase()

Method Summary

Modifier and Type	Method	Description
ReleaseResult	execute(ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, List<org.apache.maven.project.MavenProject> reactorProjects)	Execute the phase.
ReleaseResult	simulate(ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, List<org.apache.maven.project.MavenProject> reactorProjects)	Simulate the phase, but don't make any changes to the project.

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

getReleaseResultSuccess, logDebug, logDebug, logError, logInfo, logWarn

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

Field Details

scmRequired

private boolean scmRequired

Since:

2.4

snapshotsRequired

private boolean snapshotsRequired

Since:

2.5.2

scmRepositoryConfigurator

private ScmRepositoryConfigurator scmRepositoryConfigurator

Constructor Details

CheckPomPhase

public CheckPomPhase()

Method Details

execute

public ReleaseResult execute(ReleaseDescriptor releaseDescriptor,
 ReleaseEnvironment releaseEnvironment,
 List<org.apache.maven.project.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<org.apache.maven.project.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