Package org.apache.maven.shared.release

Interface ReleaseManager

All Known Implementing Classes:

DefaultReleaseManager

public interface ReleaseManager

Release management classes.

Author:

Brett Porter

Method Summary

Modifier and Type	Method	Description
void	branch(ReleaseBranchRequest branchRequest)	Branch a project
void	clean(ReleaseCleanRequest cleanRequest)	Clean a release.
void	perform(ReleasePerformRequest performRequest)	Perform a release
ReleaseResult	performWithResult(ReleasePerformRequest performRequest)	performWithResult.
void	prepare(ReleasePrepareRequest prepareRequest)	Prepare a release.
ReleaseResult	prepareWithResult(ReleasePrepareRequest prepareRequest)	prepareWithResult.
void	rollback(ReleaseRollbackRequest rollbackRequest)	Rollback changes made by the previous release
void	updateVersions(ReleaseUpdateVersionsRequest updateVersionsRequest)	Update version numbers for a project

Method Details

prepare

void prepare(ReleasePrepareRequest prepareRequest)
      throws ReleaseExecutionException,
ReleaseFailureException

Prepare a release.

Parameters:

prepareRequest - all prepare arguments

Throws:

ReleaseExecutionException - if there is a problem performing the release

ReleaseFailureException - if there is a problem performing the release

Since:

2.3

prepareWithResult

ReleaseResult prepareWithResult(ReleasePrepareRequest prepareRequest)

prepareWithResult.

Parameters:

prepareRequest - a ReleasePrepareRequest object

Returns:

a ReleaseResult object

performWithResult

ReleaseResult performWithResult(ReleasePerformRequest performRequest)

performWithResult.

Parameters:

performRequest - a ReleasePerformRequest object

Returns:

a ReleaseResult object

perform

void perform(ReleasePerformRequest performRequest)
      throws ReleaseExecutionException,
ReleaseFailureException

Perform a release

Parameters:

performRequest - all perform arguments

Throws:

ReleaseExecutionException - if there is a problem performing the release

ReleaseFailureException - if there is a problem performing the release

Since:

2.3

clean

void clean(ReleaseCleanRequest cleanRequest)
    throws ReleaseFailureException

Clean a release.

Parameters:

cleanRequest - all clean arguments

Throws:

ReleaseFailureException - if exception when releasing

Since:

2.3

rollback

void rollback(ReleaseRollbackRequest rollbackRequest)
       throws ReleaseExecutionException,
ReleaseFailureException

Rollback changes made by the previous release

Parameters:

rollbackRequest - all rollback arguments

Throws:

ReleaseExecutionException - if there is a problem during release rollback

ReleaseFailureException - if there is a problem during release rollback

Since:

2.3

branch

void branch(ReleaseBranchRequest branchRequest)
     throws ReleaseExecutionException,
ReleaseFailureException

Branch a project

Parameters:

branchRequest - all branch arguments

Throws:

ReleaseExecutionException - if there is a problem during release branch

ReleaseFailureException - if there is a problem during release branch

Since:

2.3

updateVersions

void updateVersions(ReleaseUpdateVersionsRequest updateVersionsRequest)
             throws ReleaseExecutionException,
ReleaseFailureException

Update version numbers for a project

Parameters:

updateVersionsRequest - all update versions arguments

Throws:

ReleaseExecutionException - if there is a problem during update versions

ReleaseFailureException - if there is a problem during update versions

Since:

2.3