ReleaseDescriptor (Maven Release Manager 2.5.1 API)

java.lang.Object
- org.apache.maven.shared.release.config.ReleaseDescriptor

All Implemented Interfaces:

Serializable
```
public class ReleaseDescriptor
extends Object
implements Serializable
```
Class ReleaseDescriptor.

Version:

$Revision$ $Date$

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String DEVELOPMENT_KEY

static String ORIGINAL_VERSION

static String RELEASE_KEY

Fields
Modifier and Type	Field and Description
`static String`	`DEVELOPMENT_KEY`
`static String`	`ORIGINAL_VERSION`
`static String`	`RELEASE_KEY`

Constructor Summary

Constructors
Constructor and Description

ReleaseDescriptor()

Constructors
Constructor and Description
`ReleaseDescriptor()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addCheckModificationExclude(String string)` Method addCheckModificationExclude.
`void`	`addDevelopmentVersion(Object key, String value)` Method addDevelopmentVersion.
`void`	`addOriginalScmInfo(Object key, String value)` Method addOriginalScmInfo.
`void`	`addReleaseVersion(Object key, String value)` Method addReleaseVersion.
`void`	`addResolvedSnapshotDependency(Object key, String value)` Method addResolvedSnapshotDependency.
`boolean`	`equals(Object obj)`
`String`	`getAdditionalArguments()` Get additional arguments to pass to any executed Maven process.
`List<String>`	`getCheckModificationExcludes()` Method getCheckModificationExcludes.
`String`	`getCheckoutDirectory()` Get the directory where the tag will be checked out.
`String`	`getCompletedPhase()` Get the last completed phase.
`String`	`getCompletionGoals()` Get the goals to execute in on completion of preparation for the release.
`String`	`getDefaultDevelopmentVersion()` Get default version to use for new working copy.
`String`	`getDefaultReleaseVersion()` Get default version to use for the tagged release or the new branch.
`String`	`getDependencyDevelopmentVersion(String artifactConflictId)` Retrieve the release version for the resolved snapshot dependency.
`String`	`getDependencyReleaseVersion(String artifactConflictId)` Retrieve the release version for the resolved snapshot dependency.
`String`	`getDescription()` Get the description of this release configuration.
`Map`	`getDevelopmentVersions()` Method getDevelopmentVersions.
`String`	`getModelEncoding()` Get the modelEncoding field.
`String`	`getName()` Get the name of this release configuration.
`Map`	`getOriginalScmInfo()` Method getOriginalScmInfo.
`Map<String,String>`	`getOriginalVersions(List<MavenProject> reactorProjects)` Retrieve the original version map, before transformation, keyed by project's versionless identifier.
`String`	`getPerformGoals()` Get the goals to execute in perform phase for the release.
`String`	`getPomFileName()` Get the file name of the POM to pass to any executed Maven process.
`String`	`getPreparationGoals()` Get the goals to execute in preparation for the release.
`String`	`getProjectVersionPolicyId()` Get the role-hint for the VersionPolicy implementation used to calculate the project versions.
`Map`	`getReleaseVersions()` Method getReleaseVersions.
`Map`	`getResolvedSnapshotDependencies()` Method getResolvedSnapshotDependencies.
`String`	`getScmBranchBase()` Get where you are going to put your branched sources Example https://svn.apache.org/repos/asf/maven/plugins/branches.
`String`	`getScmCommentPrefix()` Get the prefix of SCM modification messages.
`String`	`getScmId()` Get the id can be used to get the credentials by the server-id from the settings.xml.
`String`	`getScmPassword()` Get the password for the user interacting with the scm.
`String`	`getScmPrivateKey()` Get private key for an SSH based SCM repository.
`String`	`getScmPrivateKeyPassPhrase()` Get pass phrase for the private key.
`String`	`getScmRelativePathProjectDirectory()` Get relative path of the project returned by the checkout command.
`String`	`getScmReleasedPomRevision()` Get nOTE : currently only implemented with svn scm.
`String`	`getScmReleaseLabel()` Get tag or branch name: the identifier for the tag/branch.
`String`	`getScmSourceUrl()` Get this is a MavenSCM of where you're going to get the sources to make the release with.
`String`	`getScmTagBase()` Get where you are going to put your tagged sources Example https://svn.apache.org/repos/asf/maven/plugins/tags.
`String`	`getScmTagNameFormat()` Get specifies the format for generating a tag name.
`String`	`getScmUsername()` Get the user name to interact with the scm.
`int`	`getWaitBeforeTagging()` Get wait the specified number of seconds before creating a tag.
`String`	`getWorkingDirectory()` Get the directory where the release is performed.
`int`	`hashCode()`
`boolean`	`isAddSchema()` Get whether to add the model schema to the top of the rewritten POM if it wasn't there already.
`boolean`	`isAllowTimestampedSnapshots()` Get should timestamped SNAPSHOT dependencies be allowed? Default is to fail when any SNAPSHOT dependency is found.
`boolean`	`isAutoVersionSubmodules()` Get whether to use the parent pom version for submodule versions.
`boolean`	`isBranchCreation()` Get whether to create a branch instead of do a release.
`boolean`	`isCommitByProject()` Get the commits must be done by modules or not.
`boolean`	`isGenerateReleasePoms()` Get whether to generate release POMs.
`boolean`	`isInteractive()` Get whether the release process is interactive and the release manager should be prompted to confirm values, or whether the defaults are used regardless.
`boolean`	`isLocalCheckout()` Get if the scm provider should use local checkouts via file://${basedir} instead of doing a clean checkout over the network.
`boolean`	`isPushChanges()` Get should distributed changes be pushed to the central repository? For many distributed SCMs like Git, a change like a commit is only stored in your local copy of the repository.
`boolean`	`isRemoteTagging()` Get nOTE : currently only implemented with svn scm.
`boolean`	`isScmUseEditMode()` Get whether to use edit mode when making SCM modifications.
`boolean`	`isSnapshotReleasePluginAllowed()` Get whether a SNAPSHOT of the release plugin is allowed.
`boolean`	`isSuppressCommitBeforeTagOrBranch()` Get whether to suppress a commit of changes to the working copy before a tag or branch is created.
`boolean`	`isUpdateBranchVersions()` Get whether to update branch POM versions.
`boolean`	`isUpdateDependencies()` Get if updateDependencies is false, dependencies version won't be updated to the next development version.
`boolean`	`isUpdateVersionsToSnapshot()` Get whether to update branch versions to SNAPSHOT.
`boolean`	`isUpdateWorkingCopyVersions()` Get whether to update working copy POM versions.
`boolean`	`isUseReleaseProfile()` Get whether to use the release profile that adds sources and javadocs to the released artifact, if appropriate.
`void`	`mapDevelopmentVersion(String projectId, String nextVersion)` Map a given project to a specified version from when it is incremented and placed back into development.
`void`	`mapOriginalScmInfo(String projectId, Scm scm)` Map a given project to a specified set of SCM information.
`void`	`mapReleaseVersion(String projectId, String nextVersion)` Map a given project to a specified version from when it is released.
`void`	`mapResolvedSnapshotDependencies(String artifactName, String releaseVersion, String developmentVersion)` Map a given snapshot dependency to a specified version from when it is released.
`void`	`removeCheckModificationExclude(String string)` Method removeCheckModificationExclude.
`void`	`setAdditionalArguments(String additionalArguments)` Set additional arguments to pass to any executed Maven process.
`void`	`setAddSchema(boolean addSchema)` Set whether to add the model schema to the top of the rewritten POM if it wasn't there already.
`void`	`setAllowTimestampedSnapshots(boolean allowTimestampedSnapshots)` Set should timestamped SNAPSHOT dependencies be allowed? Default is to fail when any SNAPSHOT dependency is found.
`void`	`setAutoVersionSubmodules(boolean autoVersionSubmodules)` Set whether to use the parent pom version for submodule versions.
`void`	`setBranchCreation(boolean branchCreation)` Set whether to create a branch instead of do a release.
`void`	`setCheckModificationExcludes(List<String> checkModificationExcludes)` Set in some exceptions you want to allow changes to the working copy.
`void`	`setCheckoutDirectory(String checkoutDirectory)` Set the directory where the tag will be checked out.
`void`	`setCommitByProject(boolean commitByProject)` Set the commits must be done by modules or not.
`void`	`setCompletedPhase(String completedPhase)` Set the last completed phase.
`void`	`setCompletionGoals(String completionGoals)` Set the goals to execute in on completion of preparation for the release.
`void`	`setDefaultDevelopmentVersion(String defaultDevelopmentVersion)` Set default version to use for new working copy.
`void`	`setDefaultReleaseVersion(String defaultReleaseVersion)` Set default version to use for the tagged release or the new branch.
`void`	`setDescription(String description)` Set the description of this release configuration.
`void`	`setDevelopmentVersions(Map developmentVersions)` Set a map of projects to versions to use when moving the given projects back into development after release.
`void`	`setGenerateReleasePoms(boolean generateReleasePoms)` Set whether to generate release POMs.
`void`	`setInteractive(boolean interactive)` Set whether the release process is interactive and the release manager should be prompted to confirm values, or whether the defaults are used regardless.
`void`	`setLocalCheckout(boolean localCheckout)` Set if the scm provider should use local checkouts via file://${basedir} instead of doing a clean checkout over the network.
`void`	`setModelEncoding(String modelEncoding)` Set the modelEncoding field.
`void`	`setName(String name)` Set the name of this release configuration.
`void`	`setOriginalScmInfo(Map originalScmInfo)` Set a map of projects to original SCM information.
`void`	`setPerformGoals(String performGoals)` Set the goals to execute in perform phase for the release.
`void`	`setPomFileName(String pomFileName)` Set the file name of the POM to pass to any executed Maven process.
`void`	`setPreparationGoals(String preparationGoals)` Set the goals to execute in preparation for the release.
`void`	`setProjectVersionPolicyId(String projectVersionPolicyId)` Set the role-hint for the VersionPolicy implementation used to calculate the project versions.
`void`	`setPushChanges(boolean pushChanges)` Set should distributed changes be pushed to the central repository? For many distributed SCMs like Git, a change like a commit is only stored in your local copy of the repository.
`void`	`setReleaseVersions(Map releaseVersions)` Set a map of projects to versions to use when releasing the given projects.
`void`	`setRemoteTagging(boolean remoteTagging)` Set nOTE : currently only implemented with svn scm.
`void`	`setResolvedSnapshotDependencies(Map resolvedSnapshotDependencies)` Set a map of resolved snapshot dependencies versions.
`void`	`setScmBranchBase(String scmBranchBase)` Set where you are going to put your branched sources Example https://svn.apache.org/repos/asf/maven/plugins/branches.
`void`	`setScmCommentPrefix(String ScmCommentPrefix)` Set the prefix of SCM modification messages.
`void`	`setScmId(String scmId)` Set the id can be used to get the credentials by the server-id from the settings.xml.
`void`	`setScmPassword(String scmPassword)` Set the password for the user interacting with the scm.
`void`	`setScmPrivateKey(String scmPrivateKey)` Set private key for an SSH based SCM repository.
`void`	`setScmPrivateKeyPassPhrase(String scmPrivateKeyPassPhrase)` Set pass phrase for the private key.
`void`	`setScmRelativePathProjectDirectory(String scmRelativePathProjectDirectory)` Set relative path of the project returned by the checkout command.
`void`	`setScmReleasedPomRevision(String scmReleasedPomRevision)` Set nOTE : currently only implemented with svn scm.
`void`	`setScmReleaseLabel(String scmReleaseLabel)` Set tag or branch name: the identifier for the tag/branch.
`void`	`setScmSourceUrl(String scmSourceUrl)` Set this is a MavenSCM of where you're going to get the sources to make the release with.
`void`	`setScmTagBase(String scmTagBase)` Set where you are going to put your tagged sources Example https://svn.apache.org/repos/asf/maven/plugins/tags.
`void`	`setScmTagNameFormat(String scmTagNameFormat)` Set specifies the format for generating a tag name.
`void`	`setScmUseEditMode(boolean scmUseEditMode)` Set whether to use edit mode when making SCM modifications.
`void`	`setScmUsername(String scmUsername)` Set the user name to interact with the scm.
`void`	`setSnapshotReleasePluginAllowed(boolean snapshotReleasePluginAllowed)` Set whether a SNAPSHOT of the release plugin is allowed.
`void`	`setSuppressCommitBeforeTagOrBranch(boolean suppressCommitBeforeTagOrBranch)` Set whether to suppress a commit of changes to the working copy before a tag or branch is created.
`void`	`setUpdateBranchVersions(boolean updateBranchVersions)` Set whether to update branch POM versions.
`void`	`setUpdateDependencies(boolean updateDependencies)` Set if updateDependencies is false, dependencies version won't be updated to the next development version.
`void`	`setUpdateVersionsToSnapshot(boolean updateVersionsToSnapshot)` Set whether to update branch versions to SNAPSHOT.
`void`	`setUpdateWorkingCopyVersions(boolean updateWorkingCopyVersions)` Set whether to update working copy POM versions.
`void`	`setUseReleaseProfile(boolean useReleaseProfile)` Set whether to use the release profile that adds sources and javadocs to the released artifact, if appropriate.
`void`	`setWaitBeforeTagging(int waitBeforeTagging)` Set wait the specified number of seconds before creating a tag.
`void`	`setWorkingDirectory(String workingDirectory)` Set the directory where the release is performed.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEVELOPMENT_KEY
```
public static final String DEVELOPMENT_KEY
```
    See Also:
    Constant Field Values
  - RELEASE_KEY
```
public static final String RELEASE_KEY
```
    See Also:
    Constant Field Values
  - ORIGINAL_VERSION
```
public static final String ORIGINAL_VERSION
```
    See Also:
    Constant Field Values
- Constructor Detail
  - ReleaseDescriptor
```
public ReleaseDescriptor()
```
- Method Detail
  - addCheckModificationExclude
```
public void addCheckModificationExclude(String string)
```
    Method addCheckModificationExclude.
    
    Parameters:
    string -
  - addDevelopmentVersion
```
public void addDevelopmentVersion(Object key,
                         String value)
```
    Method addDevelopmentVersion.
    
    Parameters:
    key -
    value -
  - addOriginalScmInfo
```
public void addOriginalScmInfo(Object key,
                      String value)
```
    Method addOriginalScmInfo.
    
    Parameters:
    key -
    value -
  - addReleaseVersion
```
public void addReleaseVersion(Object key,
                     String value)
```
    Method addReleaseVersion.
    
    Parameters:
    key -
    value -
  - addResolvedSnapshotDependency
```
public void addResolvedSnapshotDependency(Object key,
                                 String value)
```
    Method addResolvedSnapshotDependency.
    
    Parameters:
    key -
    value -
  - getAdditionalArguments
```
public String getAdditionalArguments()
```
    Get additional arguments to pass to any executed Maven process.
    
    Returns:
    String
  - getCheckModificationExcludes
```
public List<String> getCheckModificationExcludes()
```
    Method getCheckModificationExcludes.
    
    Returns:
    List
  - getCheckoutDirectory
```
public String getCheckoutDirectory()
```
    Get the directory where the tag will be checked out.
    
    Returns:
    String
  - getCompletedPhase
```
public String getCompletedPhase()
```
    Get the last completed phase.
    
    Returns:
    String
  - getCompletionGoals
```
public String getCompletionGoals()
```
    Get the goals to execute in on completion of preparation for the release.
    
    Returns:
    String
  - getDefaultDevelopmentVersion
```
public String getDefaultDevelopmentVersion()
```
    Get default version to use for new working copy.
    
    Returns:
    String
  - getDefaultReleaseVersion
```
public String getDefaultReleaseVersion()
```
    Get default version to use for the tagged release or the new branch.
    
    Returns:
    String
  - getDescription
```
public String getDescription()
```
    Get the description of this release configuration.
    
    Returns:
    String
  - getDevelopmentVersions
```
public Map getDevelopmentVersions()
```
    Method getDevelopmentVersions.
    
    Returns:
    Map
  - getModelEncoding
```
public String getModelEncoding()
```
    Get the modelEncoding field.
    
    Returns:
    String
  - getName
```
public String getName()
```
    Get the name of this release configuration.
    
    Returns:
    String
  - getOriginalScmInfo
```
public Map getOriginalScmInfo()
```
    Method getOriginalScmInfo.
    
    Returns:
    Map
  - getPerformGoals
```
public String getPerformGoals()
```
    Get the goals to execute in perform phase for the release.
    
    Returns:
    String
  - getPomFileName
```
public String getPomFileName()
```
    Get the file name of the POM to pass to any executed Maven process.
    
    Returns:
    String
  - getPreparationGoals
```
public String getPreparationGoals()
```
    Get the goals to execute in preparation for the release.
    
    Returns:
    String
  - getProjectVersionPolicyId
```
public String getProjectVersionPolicyId()
```
    Get the role-hint for the VersionPolicy implementation used to calculate the project versions.
    
    Returns:
    String
  - getReleaseVersions
```
public Map getReleaseVersions()
```
    Method getReleaseVersions.
    
    Returns:
    Map
  - getResolvedSnapshotDependencies
```
public Map getResolvedSnapshotDependencies()
```
    Method getResolvedSnapshotDependencies.
    
    Returns:
    Map
  - getScmBranchBase
```
public String getScmBranchBase()
```
    Get where you are going to put your branched sources Example https://svn.apache.org/repos/asf/maven/plugins/branches.
    
    Returns:
    String
  - getScmCommentPrefix
```
public String getScmCommentPrefix()
```
    Get the prefix of SCM modification messages.
    
    Returns:
    String
  - getScmId
```
public String getScmId()
```
    Get the id can be used to get the credentials by the server-id from the settings.xml.
    
    Returns:
    String
  - getScmPassword
```
public String getScmPassword()
```
    Get the password for the user interacting with the scm.
    
    Returns:
    String
  - getScmPrivateKey
```
public String getScmPrivateKey()
```
    Get private key for an SSH based SCM repository.
    
    Returns:
    String
  - getScmPrivateKeyPassPhrase
```
public String getScmPrivateKeyPassPhrase()
```
    Get pass phrase for the private key.
    
    Returns:
    String
  - getScmRelativePathProjectDirectory
```
public String getScmRelativePathProjectDirectory()
```
    Get relative path of the project returned by the checkout command.
    
    Returns:
    String
  - getScmReleaseLabel
```
public String getScmReleaseLabel()
```
    Get tag or branch name: the identifier for the tag/branch. Example: maven-release-plugin-2.0.
    
    Returns:
    String
  - getScmReleasedPomRevision
```
public String getScmReleasedPomRevision()
```
    Get nOTE : currently only implemented with svn scm. It contains the revision of the committed released pom to remotely tag the source code with this revision.
    
    Returns:
    String
  - getScmSourceUrl
```
public String getScmSourceUrl()
```
    Get this is a MavenSCM of where you're going to get the sources to make the release with. Example: scm:svn:https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-release-plugin.
    
    Returns:
    String
  - getScmTagBase
```
public String getScmTagBase()
```
    Get where you are going to put your tagged sources Example https://svn.apache.org/repos/asf/maven/plugins/tags.
    
    Returns:
    String
  - getScmTagNameFormat
```
public String getScmTagNameFormat()
```
    Get specifies the format for generating a tag name. Property expansion is used with the optional prefix of project, where properties are delimited with @{ and }.
    
    Returns:
    String
  - getScmUsername
```
public String getScmUsername()
```
    Get the user name to interact with the scm.
    
    Returns:
    String
  - getWaitBeforeTagging
```
public int getWaitBeforeTagging()
```
    Get wait the specified number of seconds before creating a tag.
    
    Returns:
    int
  - getWorkingDirectory
```
public String getWorkingDirectory()
```
    Get the directory where the release is performed.
    
    Returns:
    String
  - isAddSchema
```
public boolean isAddSchema()
```
    Get whether to add the model schema to the top of the rewritten POM if it wasn't there already. If false then the root element will remain untouched.
    
    Returns:
    boolean
  - isAllowTimestampedSnapshots
```
public boolean isAllowTimestampedSnapshots()
```
    Get should timestamped SNAPSHOT dependencies be allowed? Default is to fail when any SNAPSHOT dependency is found.
    
    Returns:
    boolean
  - isAutoVersionSubmodules
```
public boolean isAutoVersionSubmodules()
```
    Get whether to use the parent pom version for submodule versions.
    
    Returns:
    boolean
  - isBranchCreation
```
public boolean isBranchCreation()
```
    Get whether to create a branch instead of do a release.
    
    Returns:
    boolean
  - isCommitByProject
```
public boolean isCommitByProject()
```
    Get the commits must be done by modules or not. Set it to true in case of flat directory structure.
    
    Returns:
    boolean
  - isGenerateReleasePoms
```
public boolean isGenerateReleasePoms()
```
    Get whether to generate release POMs.
    
    Returns:
    boolean
  - isInteractive
```
public boolean isInteractive()
```
    Get whether the release process is interactive and the release manager should be prompted to confirm values, or whether the defaults are used regardless.
    
    Returns:
    boolean
  - isLocalCheckout
```
public boolean isLocalCheckout()
```
    Get if the scm provider should use local checkouts via file://${basedir} instead of doing a clean checkout over the network. This is very helpful for releasing large projects!
    
    Returns:
    boolean
  - isPushChanges
```
public boolean isPushChanges()
```
    Get should distributed changes be pushed to the central repository? For many distributed SCMs like Git, a change like a commit is only stored in your local copy of the repository. Pushing the change allows your to more easily share it with other users.
    
    Returns:
    boolean
  - isRemoteTagging
```
public boolean isRemoteTagging()
```
    Get nOTE : currently only implemented with svn scm. Enable a workaround to prevent issue due to svn client > 1.5.0 (http://jira.codehaus.org/browse/SCM-406).
    
    Returns:
    boolean
  - isScmUseEditMode
```
public boolean isScmUseEditMode()
```
    Get whether to use edit mode when making SCM modifications. This setting is disregarded if the SCM does not support edit mode, or if edit mode is compulsory for the given SCM.
    
    Returns:
    boolean
  - isSnapshotReleasePluginAllowed
```
public boolean isSnapshotReleasePluginAllowed()
```
    Get whether a SNAPSHOT of the release plugin is allowed.
    
    Returns:
    boolean
  - isSuppressCommitBeforeTagOrBranch
```
public boolean isSuppressCommitBeforeTagOrBranch()
```
    Get whether to suppress a commit of changes to the working copy before a tag or branch is created.
    
    Returns:
    boolean
  - isUpdateBranchVersions
```
public boolean isUpdateBranchVersions()
```
    Get whether to update branch POM versions.
    
    Returns:
    boolean
  - isUpdateDependencies
```
public boolean isUpdateDependencies()
```
    Get if updateDependencies is false, dependencies version won't be updated to the next development version.
    
    Returns:
    boolean
  - isUpdateVersionsToSnapshot
```
public boolean isUpdateVersionsToSnapshot()
```
    Get whether to update branch versions to SNAPSHOT.
    
    Returns:
    boolean
  - isUpdateWorkingCopyVersions
```
public boolean isUpdateWorkingCopyVersions()
```
    Get whether to update working copy POM versions.
    
    Returns:
    boolean
  - isUseReleaseProfile
```
public boolean isUseReleaseProfile()
```
    Get whether to use the release profile that adds sources and javadocs to the released artifact, if appropriate. If set to true, this will set the property "performRelease" to true.
    
    Returns:
    boolean
  - removeCheckModificationExclude
```
public void removeCheckModificationExclude(String string)
```
    Method removeCheckModificationExclude.
    
    Parameters:
    string -
  - setAddSchema
```
public void setAddSchema(boolean addSchema)
```
    Set whether to add the model schema to the top of the rewritten POM if it wasn't there already. If false then the root element will remain untouched.
    
    Parameters:
    addSchema -
  - setAdditionalArguments
```
public void setAdditionalArguments(String additionalArguments)
```
    Set additional arguments to pass to any executed Maven process.
    
    Parameters:
    additionalArguments -
  - setAllowTimestampedSnapshots
```
public void setAllowTimestampedSnapshots(boolean allowTimestampedSnapshots)
```
    Set should timestamped SNAPSHOT dependencies be allowed? Default is to fail when any SNAPSHOT dependency is found.
    
    Parameters:
    allowTimestampedSnapshots -
  - setAutoVersionSubmodules
```
public void setAutoVersionSubmodules(boolean autoVersionSubmodules)
```
    Set whether to use the parent pom version for submodule versions.
    
    Parameters:
    autoVersionSubmodules -
  - setBranchCreation
```
public void setBranchCreation(boolean branchCreation)
```
    Set whether to create a branch instead of do a release.
    
    Parameters:
    branchCreation -
  - setCheckModificationExcludes
```
public void setCheckModificationExcludes(List<String> checkModificationExcludes)
```
    Set in some exceptions you want to allow changes to the working copy. Changes to files listed here will not make the ScmCheckModificationsPhase fail.
    
    Parameters:
    checkModificationExcludes -
  - setCheckoutDirectory
```
public void setCheckoutDirectory(String checkoutDirectory)
```
    Set the directory where the tag will be checked out.
    
    Parameters:
    checkoutDirectory -
  - setCommitByProject
```
public void setCommitByProject(boolean commitByProject)
```
    Set the commits must be done by modules or not. Set it to true in case of flat directory structure.
    
    Parameters:
    commitByProject -
  - setCompletedPhase
```
public void setCompletedPhase(String completedPhase)
```
    Set the last completed phase.
    
    Parameters:
    completedPhase -
  - setCompletionGoals
```
public void setCompletionGoals(String completionGoals)
```
    Set the goals to execute in on completion of preparation for the release.
    
    Parameters:
    completionGoals -
  - setDefaultDevelopmentVersion
```
public void setDefaultDevelopmentVersion(String defaultDevelopmentVersion)
```
    Set default version to use for new working copy.
    
    Parameters:
    defaultDevelopmentVersion -
  - setDefaultReleaseVersion
```
public void setDefaultReleaseVersion(String defaultReleaseVersion)
```
    Set default version to use for the tagged release or the new branch.
    
    Parameters:
    defaultReleaseVersion -
  - setDescription
```
public void setDescription(String description)
```
    Set the description of this release configuration.
    
    Parameters:
    description -
  - setDevelopmentVersions
```
public void setDevelopmentVersions(Map developmentVersions)
```
    Set a map of projects to versions to use when moving the given projects back into development after release.
    
    Parameters:
    developmentVersions -
  - setGenerateReleasePoms
```
public void setGenerateReleasePoms(boolean generateReleasePoms)
```
    Set whether to generate release POMs.
    
    Parameters:
    generateReleasePoms -
  - setInteractive
```
public void setInteractive(boolean interactive)
```
    Set whether the release process is interactive and the release manager should be prompted to confirm values, or whether the defaults are used regardless.
    
    Parameters:
    interactive -
  - setLocalCheckout
```
public void setLocalCheckout(boolean localCheckout)
```
    Set if the scm provider should use local checkouts via file://${basedir} instead of doing a clean checkout over the network. This is very helpful for releasing large projects!
    
    Parameters:
    localCheckout -
  - setModelEncoding
```
public void setModelEncoding(String modelEncoding)
```
    Set the modelEncoding field.
    
    Parameters:
    modelEncoding -
  - setName
```
public void setName(String name)
```
    Set the name of this release configuration.
    
    Parameters:
    name -
  - setOriginalScmInfo
```
public void setOriginalScmInfo(Map originalScmInfo)
```
    Set a map of projects to original SCM information.
    
    Parameters:
    originalScmInfo -
  - setPerformGoals
```
public void setPerformGoals(String performGoals)
```
    Set the goals to execute in perform phase for the release.
    
    Parameters:
    performGoals -
  - setPomFileName
```
public void setPomFileName(String pomFileName)
```
    Set the file name of the POM to pass to any executed Maven process.
    
    Parameters:
    pomFileName -
  - setPreparationGoals
```
public void setPreparationGoals(String preparationGoals)
```
    Set the goals to execute in preparation for the release.
    
    Parameters:
    preparationGoals -
  - setProjectVersionPolicyId
```
public void setProjectVersionPolicyId(String projectVersionPolicyId)
```
    Set the role-hint for the VersionPolicy implementation used to calculate the project versions.
    
    Parameters:
    projectVersionPolicyId -
  - setPushChanges
```
public void setPushChanges(boolean pushChanges)
```
    Set should distributed changes be pushed to the central repository? For many distributed SCMs like Git, a change like a commit is only stored in your local copy of the repository. Pushing the change allows your to more easily share it with other users.
    
    Parameters:
    pushChanges -
  - setReleaseVersions
```
public void setReleaseVersions(Map releaseVersions)
```
    Set a map of projects to versions to use when releasing the given projects.
    
    Parameters:
    releaseVersions -
  - setRemoteTagging
```
public void setRemoteTagging(boolean remoteTagging)
```
    Set nOTE : currently only implemented with svn scm. Enable a workaround to prevent issue due to svn client > 1.5.0 (http://jira.codehaus.org/browse/SCM-406).
    
    Parameters:
    remoteTagging -
  - setResolvedSnapshotDependencies
```
public void setResolvedSnapshotDependencies(Map resolvedSnapshotDependencies)
```
    Set a map of resolved snapshot dependencies versions.
    
    Parameters:
    resolvedSnapshotDependencies -
  - setScmBranchBase
```
public void setScmBranchBase(String scmBranchBase)
```
    Set where you are going to put your branched sources Example https://svn.apache.org/repos/asf/maven/plugins/branches.
    
    Parameters:
    scmBranchBase -
  - setScmCommentPrefix
```
public void setScmCommentPrefix(String ScmCommentPrefix)
```
    Set the prefix of SCM modification messages.
    
    Parameters:
    ScmCommentPrefix -
  - setScmId
```
public void setScmId(String scmId)
```
    Set the id can be used to get the credentials by the server-id from the settings.xml.
    
    Parameters:
    scmId -
  - setScmPassword
```
public void setScmPassword(String scmPassword)
```
    Set the password for the user interacting with the scm.
    
    Parameters:
    scmPassword -
  - setScmPrivateKey
```
public void setScmPrivateKey(String scmPrivateKey)
```
    Set private key for an SSH based SCM repository.
    
    Parameters:
    scmPrivateKey -
  - setScmPrivateKeyPassPhrase
```
public void setScmPrivateKeyPassPhrase(String scmPrivateKeyPassPhrase)
```
    Set pass phrase for the private key.
    
    Parameters:
    scmPrivateKeyPassPhrase -
  - setScmRelativePathProjectDirectory
```
public void setScmRelativePathProjectDirectory(String scmRelativePathProjectDirectory)
```
    Set relative path of the project returned by the checkout command.
    
    Parameters:
    scmRelativePathProjectDirectory -
  - setScmReleaseLabel
```
public void setScmReleaseLabel(String scmReleaseLabel)
```
    Set tag or branch name: the identifier for the tag/branch. Example: maven-release-plugin-2.0.
    
    Parameters:
    scmReleaseLabel -
  - setScmReleasedPomRevision
```
public void setScmReleasedPomRevision(String scmReleasedPomRevision)
```
    Set nOTE : currently only implemented with svn scm. It contains the revision of the committed released pom to remotely tag the source code with this revision.
    
    Parameters:
    scmReleasedPomRevision -
  - setScmSourceUrl
```
public void setScmSourceUrl(String scmSourceUrl)
```
    Set this is a MavenSCM of where you're going to get the sources to make the release with. Example: scm:svn:https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-release-plugin.
    
    Parameters:
    scmSourceUrl -
  - setScmTagBase
```
public void setScmTagBase(String scmTagBase)
```
    Set where you are going to put your tagged sources Example https://svn.apache.org/repos/asf/maven/plugins/tags.
    
    Parameters:
    scmTagBase -
  - setScmTagNameFormat
```
public void setScmTagNameFormat(String scmTagNameFormat)
```
    Set specifies the format for generating a tag name. Property expansion is used with the optional prefix of project, where properties are delimited with @{ and }.
    
    Parameters:
    scmTagNameFormat -
  - setScmUseEditMode
```
public void setScmUseEditMode(boolean scmUseEditMode)
```
    Set whether to use edit mode when making SCM modifications. This setting is disregarded if the SCM does not support edit mode, or if edit mode is compulsory for the given SCM.
    
    Parameters:
    scmUseEditMode -
  - setScmUsername
```
public void setScmUsername(String scmUsername)
```
    Set the user name to interact with the scm.
    
    Parameters:
    scmUsername -
  - setSnapshotReleasePluginAllowed
```
public void setSnapshotReleasePluginAllowed(boolean snapshotReleasePluginAllowed)
```
    Set whether a SNAPSHOT of the release plugin is allowed.
    
    Parameters:
    snapshotReleasePluginAllowed -
  - setSuppressCommitBeforeTagOrBranch
```
public void setSuppressCommitBeforeTagOrBranch(boolean suppressCommitBeforeTagOrBranch)
```
    Set whether to suppress a commit of changes to the working copy before a tag or branch is created.
    
    Parameters:
    suppressCommitBeforeTagOrBranch -
  - setUpdateBranchVersions
```
public void setUpdateBranchVersions(boolean updateBranchVersions)
```
    Set whether to update branch POM versions.
    
    Parameters:
    updateBranchVersions -
  - setUpdateDependencies
```
public void setUpdateDependencies(boolean updateDependencies)
```
    Set if updateDependencies is false, dependencies version won't be updated to the next development version.
    
    Parameters:
    updateDependencies -
  - setUpdateVersionsToSnapshot
```
public void setUpdateVersionsToSnapshot(boolean updateVersionsToSnapshot)
```
    Set whether to update branch versions to SNAPSHOT.
    
    Parameters:
    updateVersionsToSnapshot -
  - setUpdateWorkingCopyVersions
```
public void setUpdateWorkingCopyVersions(boolean updateWorkingCopyVersions)
```
    Set whether to update working copy POM versions.
    
    Parameters:
    updateWorkingCopyVersions -
  - setUseReleaseProfile
```
public void setUseReleaseProfile(boolean useReleaseProfile)
```
    Set whether to use the release profile that adds sources and javadocs to the released artifact, if appropriate. If set to true, this will set the property "performRelease" to true.
    
    Parameters:
    useReleaseProfile -
  - setWaitBeforeTagging
```
public void setWaitBeforeTagging(int waitBeforeTagging)
```
    Set wait the specified number of seconds before creating a tag.
    
    Parameters:
    waitBeforeTagging -
  - setWorkingDirectory
```
public void setWorkingDirectory(String workingDirectory)
```
    Set the directory where the release is performed.
    
    Parameters:
    workingDirectory -
  - mapResolvedSnapshotDependencies
```
public void mapResolvedSnapshotDependencies(String artifactName,
                                   String releaseVersion,
                                   String developmentVersion)
```
    Map a given snapshot dependency to a specified version from when it is released.
  - mapReleaseVersion
```
public void mapReleaseVersion(String projectId,
                     String nextVersion)
```
    Map a given project to a specified version from when it is released.
    
    Parameters:
    projectId - the project's group and artifact ID
    nextVersion - the version to map to
  - mapDevelopmentVersion
```
public void mapDevelopmentVersion(String projectId,
                         String nextVersion)
```
    Map a given project to a specified version from when it is incremented and placed back into development.
    
    Parameters:
    projectId - the project's group and artifact ID
    nextVersion - the version to map to
  - mapOriginalScmInfo
```
public void mapOriginalScmInfo(String projectId,
                      Scm scm)
```
    Map a given project to a specified set of SCM information.
    
    Parameters:
    projectId - the project's group and artifact ID
    scm - the original SCM information to store
  - getOriginalVersions
```
public Map<String,String> getOriginalVersions(List<MavenProject> reactorProjects)
```
    Retrieve the original version map, before transformation, keyed by project's versionless identifier.
    
    Parameters:
    reactorProjects - The reactor projects.
    
    Returns:
    the map of project IDs to versions.
  - getDependencyDevelopmentVersion
```
public String getDependencyDevelopmentVersion(String artifactConflictId)
```
    Retrieve the release version for the resolved snapshot dependency.
  - getDependencyReleaseVersion
```
public String getDependencyReleaseVersion(String artifactConflictId)
```
    Retrieve the release version for the resolved snapshot dependency.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class ReleaseDescriptor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEVELOPMENT_KEY

RELEASE_KEY

ORIGINAL_VERSION

Constructor Detail

ReleaseDescriptor

Method Detail

addCheckModificationExclude

addDevelopmentVersion

addOriginalScmInfo

addReleaseVersion

addResolvedSnapshotDependency

getAdditionalArguments

getCheckModificationExcludes

getCheckoutDirectory

getCompletedPhase

getCompletionGoals

getDefaultDevelopmentVersion

getDefaultReleaseVersion

getDescription

getDevelopmentVersions

getModelEncoding

getName

getOriginalScmInfo

getPerformGoals

getPomFileName

getPreparationGoals

getProjectVersionPolicyId

getReleaseVersions

getResolvedSnapshotDependencies

getScmBranchBase

getScmCommentPrefix

getScmId

getScmPassword

getScmPrivateKey

getScmPrivateKeyPassPhrase

getScmRelativePathProjectDirectory

getScmReleaseLabel

getScmReleasedPomRevision

getScmSourceUrl

getScmTagBase

getScmTagNameFormat

getScmUsername

getWaitBeforeTagging

getWorkingDirectory

isAddSchema

isAllowTimestampedSnapshots

isAutoVersionSubmodules

isBranchCreation

isCommitByProject

isGenerateReleasePoms

isInteractive

isLocalCheckout

isPushChanges

isRemoteTagging

isScmUseEditMode

isSnapshotReleasePluginAllowed

isSuppressCommitBeforeTagOrBranch

isUpdateBranchVersions

isUpdateDependencies

isUpdateVersionsToSnapshot

isUpdateWorkingCopyVersions

isUseReleaseProfile

removeCheckModificationExclude

setAddSchema

setAdditionalArguments

setAllowTimestampedSnapshots

setAutoVersionSubmodules

setBranchCreation

setCheckModificationExcludes

setCheckoutDirectory

setCommitByProject

setCompletedPhase

setCompletionGoals

setDefaultDevelopmentVersion