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

Interface ReleasePhase

All Known Implementing Classes:

AbstractBackupPomsPhase, AbstractReleasePhase, AbstractReleasePomsPhase, AbstractRewritePomsPhase, AbstractRunGoalsPhase, AbstractScmCommitPhase, CheckCompletedPreparePhasesPhase, CheckDependencySnapshotsPhase, CheckoutProjectFromScm, CheckPomPhase, CreateBackupPomsPhase, EndReleasePhase, GenerateReleasePomsPhase, InputVariablesPhase, MapVersionsPhase, RemoveReleasePomsPhase, RemoveScmTagPhase, RestoreBackupPomsPhase, RewritePomsForBranchPhase, RewritePomsForDevelopmentPhase, RewritePomsForReleasePhase, RewritePomVersionsPhase, RunCompleteGoalsPhase, RunPerformGoalsPhase, RunPrepareGoalsPhase, ScmBranchPhase, ScmCheckModificationsPhase, ScmCommitDevelopmentPhase, ScmCommitPreparationPhase, ScmTagPhase

public interface ReleasePhase

A phase in the release cycle.

Method Summary

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

Method Detail

execute

ReleaseResult execute(ReleaseDescriptor releaseDescriptor,
                      ReleaseEnvironment releaseEnvironment,
                      java.util.List<org.apache.maven.project.MavenProject> reactorProjects)
               throws ReleaseExecutionException,
                      ReleaseFailureException

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

ReleaseResult simulate(ReleaseDescriptor releaseDescriptor,
                       ReleaseEnvironment releaseEnvironment,
                       java.util.List<org.apache.maven.project.MavenProject> reactorProjects)
                throws ReleaseExecutionException,
                       ReleaseFailureException

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