AbstractReleasePhase (Maven Release Manager 2.5.1 API)

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

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

All Implemented Interfaces:

ReleasePhase, org.codehaus.plexus.logging.LogEnabled

Direct Known Subclasses:

AbstractBackupPomsPhase, AbstractReleasePomsPhase, AbstractRewritePomsPhase, AbstractRunGoalsPhase, AbstractScmCommitPhase, CheckCompletedPreparePhasesPhase, CheckDependencySnapshotsPhase, CheckoutProjectFromScm, CheckPomPhase, EndReleasePhase, InputVariablesPhase, MapVersionsPhase, RemoveScmTagPhase, ScmBranchPhase, ScmCheckModificationsPhase, ScmTagPhase
```
public abstract class AbstractReleasePhase
extends org.codehaus.plexus.logging.AbstractLogEnabled
implements ReleasePhase
```
Base class for all phases.

Author:

Brett Porter

Field Summary
- Fields inherited from interface org.apache.maven.shared.release.phase.ReleasePhase
  ROLE

Constructor Summary

Constructors
Constructor and Description

AbstractReleasePhase()

Method Summary

Methods
Modifier and Type	Method and Description
`ReleaseResult`	`clean(List<MavenProject> reactorProjects)` Clean up after a phase if it leaves any additional files in the checkout.
`ReleaseResult`	`execute(ReleaseDescriptor releaseDescriptor, Settings settings, List<MavenProject> reactorProjects)` Execute the phase.
`protected ReleaseResult`	`getReleaseResultSuccess()`
`protected ResourceBundle`	`getResourceBundle(Locale locale)`
`protected void`	`logDebug(ReleaseResult result, String message)`
`protected void`	`logDebug(ReleaseResult result, String message, Exception e)`
`protected void`	`logError(ReleaseResult result, String message)`
`protected void`	`logInfo(ReleaseResult result, String message)`
`protected void`	`logWarn(ReleaseResult result, String message)`
`ReleaseResult`	`simulate(ReleaseDescriptor releaseDescriptor, Settings settings, List<MavenProject> reactorProjects)` Simulate the phase, but don't make any changes to the project.

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

Methods inherited from interface org.apache.maven.shared.release.phase.ReleasePhase
execute, simulate

Constructor Detail
- AbstractReleasePhase
```
public AbstractReleasePhase()
```

Method Detail

getResourceBundle

protected ResourceBundle getResourceBundle(Locale locale)

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

Parameters:
reactorProjects - the reactor projects

Returns:
the release result

execute
```
public ReleaseResult execute(ReleaseDescriptor releaseDescriptor,
                    Settings settings,
                    List<MavenProject> reactorProjects)
                      throws ReleaseExecutionException,
                             ReleaseFailureException
```
Description copied from interface: ReleasePhase

Execute the phase.

Specified by:

execute in interface ReleasePhase

Parameters:
releaseDescriptor - the configuration to use
settings - the settings.xml configuration
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,
                     Settings settings,
                     List<MavenProject> reactorProjects)
                       throws ReleaseExecutionException,
                              ReleaseFailureException
```
Description copied from interface: ReleasePhase

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

Specified by:

simulate in interface ReleasePhase

Parameters:
releaseDescriptor - the configuration to use
settings - the settings.xml configuration
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

logInfo

protected void logInfo(ReleaseResult result,
           String message)

logWarn

protected void logWarn(ReleaseResult result,
           String message)

logError

protected void logError(ReleaseResult result,
            String message)

logDebug

protected void logDebug(ReleaseResult result,
            String message)

logDebug

protected void logDebug(ReleaseResult result,
            String message,
            Exception e)

getReleaseResultSuccess

protected ReleaseResult getReleaseResultSuccess()

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2002–2014 The Apache Software Foundation. All rights reserved.