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

java.lang.Object
  extended by org.codehaus.plexus.logging.AbstractLogEnabled
      extended by org.apache.maven.shared.release.phase.AbstractReleasePhase
          extended by org.apache.maven.shared.release.phase.AbstractRewritePomsPhase
All Implemented Interfaces:
ReleasePhase, org.codehaus.plexus.logging.LogEnabled
Direct Known Subclasses:
RewritePomsForBranchPhase, RewritePomsForDevelopmentPhase, RewritePomsForReleasePhase

public abstract class AbstractRewritePomsPhase
extends AbstractReleasePhase

Base class for rewriting phases.

Author:
Brett Porter

Field Summary
 
Fields inherited from interface org.apache.maven.shared.release.phase.ReleasePhase
ROLE
 
Constructor Summary
AbstractRewritePomsPhase()
           
 
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.
protected abstract  java.util.Map getNextVersionMap(ReleaseDescriptor releaseDescriptor)
           
protected  java.lang.String getOriginalResolvedSnapshotVersion(java.lang.String artifactVersionlessKey, java.util.Map resolvedSnapshots)
           
protected abstract  java.util.Map getOriginalVersionMap(ReleaseDescriptor releaseDescriptor, java.util.List reactorProjects)
           
protected abstract  java.lang.String getResolvedSnapshotVersion(java.lang.String artifactVersionlessKey, java.util.Map resolvedSnapshots)
           
protected  org.jdom.Element rewriteElement(java.lang.String name, java.lang.String value, org.jdom.Element root, org.jdom.Namespace namespace)
           
 ReleaseResult simulate(ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, java.util.List reactorProjects)
          Simulate the phase, but don't make any changes to the project.
protected abstract  void transformScm(org.apache.maven.project.MavenProject project, org.jdom.Element rootElement, org.jdom.Namespace namespace, ReleaseDescriptor releaseDescriptor, java.lang.String projectId, org.apache.maven.scm.repository.ScmRepository scmRepository, ReleaseResult result, org.apache.maven.project.MavenProject rootProject)
           
 
Methods inherited from class org.apache.maven.shared.release.phase.AbstractReleasePhase
execute, getReleaseResultSuccess, 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

AbstractRewritePomsPhase

public AbstractRewritePomsPhase()
Method Detail

execute

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

clean

public ReleaseResult clean(java.util.List 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

getResolvedSnapshotVersion

protected abstract java.lang.String getResolvedSnapshotVersion(java.lang.String artifactVersionlessKey,
                                                               java.util.Map resolvedSnapshots)

getOriginalVersionMap

protected abstract java.util.Map getOriginalVersionMap(ReleaseDescriptor releaseDescriptor,
                                                       java.util.List reactorProjects)

getNextVersionMap

protected abstract java.util.Map getNextVersionMap(ReleaseDescriptor releaseDescriptor)

transformScm

protected abstract void transformScm(org.apache.maven.project.MavenProject project,
                                     org.jdom.Element rootElement,
                                     org.jdom.Namespace namespace,
                                     ReleaseDescriptor releaseDescriptor,
                                     java.lang.String projectId,
                                     org.apache.maven.scm.repository.ScmRepository scmRepository,
                                     ReleaseResult result,
                                     org.apache.maven.project.MavenProject rootProject)
                              throws ReleaseExecutionException
Throws:
ReleaseExecutionException

getOriginalResolvedSnapshotVersion

protected java.lang.String getOriginalResolvedSnapshotVersion(java.lang.String artifactVersionlessKey,
                                                              java.util.Map resolvedSnapshots)

rewriteElement

protected org.jdom.Element rewriteElement(java.lang.String name,
                                          java.lang.String value,
                                          org.jdom.Element root,
                                          org.jdom.Namespace namespace)


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