org.apache.maven.shared.release.phase
Class CreateBackupPomsPhase

java.lang.Object
  org.codehaus.plexus.logging.AbstractLogEnabled
      org.apache.maven.shared.release.phase.AbstractReleasePhase
          org.apache.maven.shared.release.phase.AbstractBackupPomsPhase
              org.apache.maven.shared.release.phase.CreateBackupPomsPhase

All Implemented Interfaces:

ReleasePhase, org.codehaus.plexus.logging.LogEnabled

public class CreateBackupPomsPhase
extends AbstractBackupPomsPhase

Author:

Edwin Punzalan

Plexus component:

role:

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

role-hint:

"create-backup-poms"

Field Summary

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

ROLE

Constructor Summary

CreateBackupPomsPhase()

Method Summary

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.
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.AbstractBackupPomsPhase

deletePomBackup, getPomBackup

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

execute, getReleaseResultSuccess, 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

CreateBackupPomsPhase

public CreateBackupPomsPhase()

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

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

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