org.apache.maven.shared.release.phase
Interface ReleasePhase

All Known Implementing Classes:
AbstractBackupPomsPhase, AbstractReleasePhase, AbstractReleasePomsPhase, AbstractRewritePomsPhase, AbstractRunGoalsPhase, CheckCompletedPreparePhasesPhase, CheckDependencySnapshotsPhase, CheckoutProjectFromScm, CheckPomPhase, CreateBackupPomsPhase, EndReleasePhase, GenerateReleasePomsPhase, InputVariablesPhase, MapVersionsPhase, RemoveReleasePomsPhase, RemoveScmTagPhase, RestoreBackupPomsPhase, RewritePomsForBranchPhase, RewritePomsForDevelopmentPhase, RewritePomsForReleasePhase, RunPerformGoalsPhase, RunPrepareGoalsPhase, ScmBranchPhase, ScmCheckModificationsPhase, ScmCommitPhase, ScmTagPhase

public interface ReleasePhase

A phase in the release cycle.

Author:
Brett Porter

Field Summary
static java.lang.String ROLE
          The Plexus role.
 
Method Summary
 ReleaseResult clean(java.util.List reactorProjects)
          Clean up after a phase if it leaves any additional files in the checkout.
 ReleaseResult execute(ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, java.util.List reactorProjects)
          Execute the phase.
 ReleaseResult execute(ReleaseDescriptor releaseDescriptor, org.apache.maven.settings.Settings settings, java.util.List reactorProjects)
          Deprecated. Use execute(ReleaseDescriptor, ReleaseEnvironment, List) instead.
 ReleaseResult simulate(ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, java.util.List reactorProjects)
          Simulate the phase, but don't make any changes to the project.
 ReleaseResult simulate(ReleaseDescriptor releaseDescriptor, org.apache.maven.settings.Settings settings, java.util.List reactorProjects)
          Deprecated. Use simulate(ReleaseDescriptor, ReleaseEnvironment, List) instead.
 

Field Detail

ROLE

static final java.lang.String ROLE
The Plexus role.

Method Detail

execute

ReleaseResult execute(ReleaseDescriptor releaseDescriptor,
                      ReleaseEnvironment releaseEnvironment,
                      java.util.List 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
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 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
Throws:
ReleaseExecutionException - an exception during the execution of the phase
ReleaseFailureException - a failure during the execution of the phase

execute

ReleaseResult execute(ReleaseDescriptor releaseDescriptor,
                      org.apache.maven.settings.Settings settings,
                      java.util.List reactorProjects)
                      throws ReleaseExecutionException,
                             ReleaseFailureException
Deprecated. Use execute(ReleaseDescriptor, ReleaseEnvironment, List) instead.

Execute the phase.

Parameters:
releaseDescriptor - the configuration to use
settings - the settings.xml configuration
reactorProjects - the reactor projects
Throws:
ReleaseExecutionException - an exception during the execution of the phase
ReleaseFailureException - a failure during the execution of the phase

simulate

ReleaseResult simulate(ReleaseDescriptor releaseDescriptor,
                       org.apache.maven.settings.Settings settings,
                       java.util.List reactorProjects)
                       throws ReleaseExecutionException,
                              ReleaseFailureException
Deprecated. Use simulate(ReleaseDescriptor, ReleaseEnvironment, List) instead.

Simulate the phase, but don't make any changes to the project.

Parameters:
releaseDescriptor - the configuration to use
settings - the settings.xml configuration
reactorProjects - the reactor projects
Throws:
ReleaseExecutionException - an exception during the execution of the phase
ReleaseFailureException - a failure during the execution of the phase

clean

ReleaseResult clean(java.util.List reactorProjects)
Clean up after a phase if it leaves any additional files in the checkout.

Parameters:
reactorProjects - the reactor projects


Copyright © 2002-2009 Apache Software Foundation. All Rights Reserved.