ModelloReleaseDescriptor (Maven Release Manager 3.1.1 API)

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ReleaseDescriptorBuilder.BuilderReleaseDescriptor
```
public class ModelloReleaseDescriptor
extends Object
implements Serializable
```
Class ModelloReleaseDescriptor.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

ModelloReleaseDescriptor()

Constructors
Constructor and Description
`ModelloReleaseDescriptor()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addActivateProfile(String string)` Method addActivateProfile.
`void`	`addCheckModificationExclude(String string)` Method addCheckModificationExclude.
`void`	`addDependencyDevelopmentVersion(String dependencyKey, String version)`
`void`	`addDependencyOriginalVersion(String dependencyKey, String version)`
`void`	`addDependencyReleaseVersion(String dependencyKey, String version)`
`void`	`addDevelopmentVersion(String projectId, String version)` Method addDevelopmentVersion.
`void`	`addOriginalScmInfo(String key, org.apache.maven.model.Scm value)` Method addOriginalScmInfo.
`void`	`addOriginalVersion(String projectId, String version)`
`void`	`addReleaseVersion(String projectId, String version)` Method addReleaseVersion.
`boolean`	`equals(Object obj)`
`List<String>`	`getActivateProfiles()` Method getActivateProfiles.
`String`	`getAdditionalArguments()` Get additional arguments to pass to any executed Maven process.
`String`	`getAutoResolveSnapshots()` Get specifies whether unresolved SNAPSHOT dependencies are automatically resolved.
`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`	`getDependencyOriginalVersion(String artifactConflictId)` Retrieve the original 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.
`String`	`getLineSeparator()` Get specifies the line separator to use in the pom.xml.
`String`	`getModelEncoding()` Get the modelEncoding field.
`String`	`getName()` Get the name of this release configuration.
`org.apache.maven.model.Scm`	`getOriginalScmInfo(String id)` Method getOriginalScmInfo.
`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`	`getProjectDevelopmentVersion(String projectId)`
`String`	`getProjectNamingPolicyId()` Get the role-hint for the NamingPolicy implementation used to calculate the project branch and tag names.
`String`	`getProjectOriginalVersion(String projectId)`
`String`	`getProjectReleaseVersion(String projectId)`
`Object`	`getProjectVersionPolicyConfig()` Get the optional config string for the VersionPolicy implementation used to calculate the project versions.
`String`	`getProjectVersionPolicyId()` Get the role-hint for the VersionPolicy implementation used to calculate the project versions.
`String`	`getReleaseStrategyId()` Get the role-hint for the release Strategy implementation.
`String`	`getScmBranchBase()` Get where you are going to put your branched sources Example https://svn.apache.org/repos/asf/maven/plugins/branches.
`String`	`getScmBranchCommitComment()` Get the SCM commit comment when branching.
`String`	`getScmCommentPrefix()` Get the prefix of SCM modification messages.
`String`	`getScmDevelopmentCommitComment()` Get the SCM commit comment when setting pom.xml back to development.
`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`	`getScmReleaseCommitComment()` Get the SCM commit comment when setting pom.xml to release.
`String`	`getScmReleasedPomRevision()` Get nOTE : currently only implemented with svn scm.
`String`	`getScmReleaseLabel()` Get tag or branch name: the identifier for the tag/branch.
`String`	`getScmRollbackCommitComment()` Get the SCM commit comment when rolling back.
`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.
`String`	`getWorkItem()` Get some SCMs may require a Work Item or a Task to allow the changes to be pushed or delivered.
`int`	`hashCode()`
`boolean`	`hasOriginalScmInfo(String id)` Method hasOriginalScmInfo.
`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`	`isPinExternals()` Get enable the "--pin-externals" option in svn copy commands which is new in Subversion 1.9.
`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`	`isScmShallowClone()` Get get whether to use a shallow clone with no history or a full clone containing the full history during the release.
`boolean`	`isScmSignTags()` Get if the scm provider should use sign tags, for example for git-exe the '--sign' argument would be used.
`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`	`removeActivateProfile(String string)` Method removeActivateProfile.
`void`	`removeCheckModificationExclude(String string)` Method removeCheckModificationExclude.
`void`	`setActivateProfiles(List<String> activateProfiles)` Set list of profiles to activate.
`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`	`setAutoResolveSnapshots(String autoResolveSnapshots)` Set specifies whether unresolved SNAPSHOT dependencies are automatically resolved.
`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`	`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`	`setLineSeparator(String lineSeparator)` Set specifies the line separator to use in the pom.xml.
`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`	`setPerformGoals(String performGoals)` Set the goals to execute in perform phase for the release.
`void`	`setPinExternals(boolean pinExternals)` Set enable the "--pin-externals" option in svn copy commands which is new in Subversion 1.9.
`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`	`setProjectNamingPolicyId(String projectNamingPolicyId)` Set the role-hint for the NamingPolicy implementation used to calculate the project branch and tag names.
`void`	`setProjectVersionPolicyConfig(Object projectVersionPolicyConfig)` Set the optional config string for the VersionPolicy implementation used to calculate the project versions.
`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`	`setReleaseStrategyId(String releaseStrategyId)` Set the role-hint for the release Strategy implementation.
`void`	`setRemoteTagging(boolean remoteTagging)` Set nOTE : currently only implemented with svn scm.
`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`	`setScmBranchCommitComment(String scmBranchCommitComment)` Set the SCM commit comment when branching.
`void`	`setScmCommentPrefix(String ScmCommentPrefix)` Set the prefix of SCM modification messages.
`void`	`setScmDevelopmentCommitComment(String scmDevelopmentCommitComment)` Set the SCM commit comment when setting pom.xml back to development.
`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`	`setScmReleaseCommitComment(String scmReleaseCommitComment)` Set the SCM commit comment when setting pom.xml to release.
`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`	`setScmRollbackCommitComment(String scmRollbackCommitComment)` Set the SCM commit comment when rolling back.
`void`	`setScmShallowClone(boolean scmShallowClone)` Set get whether to use a shallow clone with no history or a full clone containing the full history during the release.
`void`	`setScmSignTags(boolean scmSignTags)` Set if the scm provider should use sign tags, for example for git-exe the '--sign' argument would be used.
`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.
`void`	`setWorkItem(String workItem)` Set some SCMs may require a Work Item or a Task to allow the changes to be pushed or delivered.

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

- Constructor Detail
  - ModelloReleaseDescriptor
```
public ModelloReleaseDescriptor()
```
- Method Detail
  - addActivateProfile
```
public void addActivateProfile(String string)
```
    Method addActivateProfile.
    
    Parameters:
    
    string - a string object.
  - addCheckModificationExclude
```
public void addCheckModificationExclude(String string)
```
    Method addCheckModificationExclude.
    
    Parameters:
    
    string - a string object.
  - getActivateProfiles
```
public List<String> getActivateProfiles()
```
    Method getActivateProfiles.
    
    Returns:
    
    List
  - getAdditionalArguments
```
public String getAdditionalArguments()
```
    Get additional arguments to pass to any executed Maven process.
    
    Returns:
    
    String
  - getAutoResolveSnapshots
```
public String getAutoResolveSnapshots()
```
    Get specifies whether unresolved SNAPSHOT dependencies are automatically resolved. If set, it is used as the answer to use when being asked how unresolved SNAPSHOT dependencies should be resolved:
    - "all" or "0": resolve all kinds of snapshots, ie. project, plugin, report and extension dependencies
    - "dependencies" or "1": resolve project dependencies
    - "plugins" or "2": resolve plugin dependencies
    - "reports" or "3": resolve report dependencies
    - "extensions" or "4": resolve extension dependencies
    Additionally this implies that the default values for the dependency's release and next development version are used.
    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
  - getLineSeparator
```
public String getLineSeparator()
```
    Get specifies the line separator to use in the pom.xml.
    
    Returns:
    
    String
  - getModelEncoding
```
public String getModelEncoding()
```
    Get the modelEncoding field.
    
    Returns:
    
    String
  - getName
```
public String getName()
```
    Get the name of this release configuration.
    
    Returns:
    
    String
  - 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
  - getProjectNamingPolicyId
```
public String getProjectNamingPolicyId()
```
    Get the role-hint for the NamingPolicy implementation used to calculate the project branch and tag names.
    
    Returns:
    
    String
  - getProjectVersionPolicyConfig
```
public Object getProjectVersionPolicyConfig()
```
    Get the optional config string for the VersionPolicy implementation used to calculate the project versions. The format of this depends on the specific VersionPolicy that is used.
    
    Returns:
    
    Object
  - getProjectVersionPolicyId
```
public String getProjectVersionPolicyId()
```
    Get the role-hint for the VersionPolicy implementation used to calculate the project versions.
    
    Returns:
    
    String
  - getReleaseStrategyId
```
public String getReleaseStrategyId()
```
    Get the role-hint for the release Strategy implementation.
    
    Returns:
    
    String
  - 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
  - getScmBranchCommitComment
```
public String getScmBranchCommitComment()
```
    Get the SCM commit comment when branching.
    
    Returns:
    
    String
  - getScmCommentPrefix
```
public String getScmCommentPrefix()
```
    Get the prefix of SCM modification messages.
    
    Returns:
    
    String
  - getScmDevelopmentCommitComment
```
public String getScmDevelopmentCommitComment()
```
    Get the SCM commit comment when setting pom.xml back to development.
    
    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
  - getScmReleaseCommitComment
```
public String getScmReleaseCommitComment()
```
    Get the SCM commit comment when setting pom.xml to release.
    
    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
  - getScmRollbackCommitComment
```
public String getScmRollbackCommitComment()
```
    Get the SCM commit comment when rolling back.
    
    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
  - getWorkItem
```
public String getWorkItem()
```
    Get some SCMs may require a Work Item or a Task to allow the changes to be pushed or delivered. This field allows you to specify that Work Item or Task. It is optional, and only relevant if pushChanges is true.
    
    Returns:
    
    String
  - 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
  - isPinExternals
```
public boolean isPinExternals()
```
    Get enable the "--pin-externals" option in svn copy commands which is new in Subversion 1.9. NOTE : Currently only implemented with Subversion. (https://issues.apache.org/jira/browse/SCM-805).
    
    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 (https://issues.apache.org/jira/browse/SCM-406).
    
    Returns:
    
    boolean
  - isScmShallowClone
```
public boolean isScmShallowClone()
```
    Get get whether to use a shallow clone with no history or a full clone containing the full history during the release.
    
    Returns:
    
    boolean
  - isScmSignTags
```
public boolean isScmSignTags()
```
    Get if the scm provider should use sign tags, for example for git-exe the '--sign' argument would be used.
    
    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
  - removeActivateProfile
```
public void removeActivateProfile(String string)
```
    Method removeActivateProfile.
    
    Parameters:
    
    string - a string object.
  - removeCheckModificationExclude
```
public void removeCheckModificationExclude(String string)
```
    Method removeCheckModificationExclude.
    
    Parameters:
    
    string - a string object.
  - setActivateProfiles
```
public void setActivateProfiles(List<String> activateProfiles)
```
    Set list of profiles to activate.
    
    Parameters:
    
    activateProfiles - a activateProfiles object.
  - 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 - a addSchema object.
  - setAdditionalArguments
```
public void setAdditionalArguments(String additionalArguments)
```
    Set additional arguments to pass to any executed Maven process.
    
    Parameters:
    
    additionalArguments - a additionalArguments object.
  - 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 - a allowTimestampedSnapshots object.
  - setAutoResolveSnapshots
```
public void setAutoResolveSnapshots(String autoResolveSnapshots)
```
    Set specifies whether unresolved SNAPSHOT dependencies are automatically resolved. If set, it is used as the answer to use when being asked how unresolved SNAPSHOT dependencies should be resolved:
    - "all" or "0": resolve all kinds of snapshots, ie. project, plugin, report and extension dependencies
    - "dependencies" or "1": resolve project dependencies
    - "plugins" or "2": resolve plugin dependencies
    - "reports" or "3": resolve report dependencies
    - "extensions" or "4": resolve extension dependencies
    Additionally this implies that the default values for the dependency's release and next development version are used.
    Parameters:
    
    autoResolveSnapshots - a autoResolveSnapshots object.
  - setAutoVersionSubmodules
```
public void setAutoVersionSubmodules(boolean autoVersionSubmodules)
```
    Set whether to use the parent pom version for submodule versions.
    
    Parameters:
    
    autoVersionSubmodules - a autoVersionSubmodules object.
  - setBranchCreation
```
public void setBranchCreation(boolean branchCreation)
```
    Set whether to create a branch instead of do a release.
    
    Parameters:
    
    branchCreation - a branchCreation object.
  - 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 - a checkModificationExcludes object.
  - setCheckoutDirectory
```
public void setCheckoutDirectory(String checkoutDirectory)
```
    Set the directory where the tag will be checked out.
    
    Parameters:
    
    checkoutDirectory - a checkoutDirectory object.
  - 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 - a commitByProject object.
  - setCompletedPhase
```
public void setCompletedPhase(String completedPhase)
```
    Set the last completed phase.
    
    Parameters:
    
    completedPhase - a completedPhase object.
  - setCompletionGoals
```
public void setCompletionGoals(String completionGoals)
```
    Set the goals to execute in on completion of preparation for the release.
    
    Parameters:
    
    completionGoals - a completionGoals object.
  - setDefaultDevelopmentVersion
```
public void setDefaultDevelopmentVersion(String defaultDevelopmentVersion)
```
    Set default version to use for new working copy.
    
    Parameters:
    
    defaultDevelopmentVersion - a defaultDevelopmentVersion object.
  - setDefaultReleaseVersion
```
public void setDefaultReleaseVersion(String defaultReleaseVersion)
```
    Set default version to use for the tagged release or the new branch.
    
    Parameters:
    
    defaultReleaseVersion - a defaultReleaseVersion object.
  - setDescription
```
public void setDescription(String description)
```
    Set the description of this release configuration.
    
    Parameters:
    
    description - a description object.
  - setGenerateReleasePoms
```
public void setGenerateReleasePoms(boolean generateReleasePoms)
```
    Set whether to generate release POMs.
    
    Parameters:
    
    generateReleasePoms - a generateReleasePoms object.
  - 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 - a interactive object.
  - setLineSeparator
```
public void setLineSeparator(String lineSeparator)
```
    Set specifies the line separator to use in the pom.xml.
    
    Parameters:
    
    lineSeparator - a lineSeparator object.
  - 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 - a localCheckout object.
  - setModelEncoding
```
public void setModelEncoding(String modelEncoding)
```
    Set the modelEncoding field.
    
    Parameters:
    
    modelEncoding - a modelEncoding object.
  - setName
```
public void setName(String name)
```
    Set the name of this release configuration.
    
    Parameters:
    
    name - a name object.
  - setPerformGoals
```
public void setPerformGoals(String performGoals)
```
    Set the goals to execute in perform phase for the release.
    
    Parameters:
    
    performGoals - a performGoals object.
  - setPinExternals
```
public void setPinExternals(boolean pinExternals)
```
    Set enable the "--pin-externals" option in svn copy commands which is new in Subversion 1.9. NOTE : Currently only implemented with Subversion. (https://issues.apache.org/jira/browse/SCM-805).
    
    Parameters:
    
    pinExternals - a pinExternals object.
  - setPomFileName
```
public void setPomFileName(String pomFileName)
```
    Set the file name of the POM to pass to any executed Maven process.
    
    Parameters:
    
    pomFileName - a pomFileName object.
  - setPreparationGoals
```
public void setPreparationGoals(String preparationGoals)
```
    Set the goals to execute in preparation for the release.
    
    Parameters:
    
    preparationGoals - a preparationGoals object.
  - setProjectNamingPolicyId
```
public void setProjectNamingPolicyId(String projectNamingPolicyId)
```
    Set the role-hint for the NamingPolicy implementation used to calculate the project branch and tag names.
    
    Parameters:
    
    projectNamingPolicyId - a projectNamingPolicyId object.
  - setProjectVersionPolicyConfig
```
public void setProjectVersionPolicyConfig(Object projectVersionPolicyConfig)
```
    Set the optional config string for the VersionPolicy implementation used to calculate the project versions. The format of this depends on the specific VersionPolicy that is used.
    
    Parameters:
    
    projectVersionPolicyConfig - a projectVersionPolicyConfig object.
  - setProjectVersionPolicyId
```
public void setProjectVersionPolicyId(String projectVersionPolicyId)
```
    Set the role-hint for the VersionPolicy implementation used to calculate the project versions.
    
    Parameters:
    
    projectVersionPolicyId - a projectVersionPolicyId object
  - 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 - a pushChanges object.
  - setReleaseStrategyId
```
public void setReleaseStrategyId(String releaseStrategyId)
```
    Set the role-hint for the release Strategy implementation.
    
    Parameters:
    
    releaseStrategyId - a releaseStrategyId object.
  - 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 (https://issues.apache.org/jira/browse/SCM-406).
    
    Parameters:
    
    remoteTagging - a remoteTagging object.
  - 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 - a scmBranchBase object.
  - setScmBranchCommitComment
```
public void setScmBranchCommitComment(String scmBranchCommitComment)
```
    Set the SCM commit comment when branching.
    
    Parameters:
    
    scmBranchCommitComment - a scmBranchCommitComment object
  - setScmCommentPrefix
```
public void setScmCommentPrefix(String ScmCommentPrefix)
```
    Set the prefix of SCM modification messages.
    
    Parameters:
    
    ScmCommentPrefix - a ScmCommentPrefix object.
  - setScmDevelopmentCommitComment
```
public void setScmDevelopmentCommitComment(String scmDevelopmentCommitComment)
```
    Set the SCM commit comment when setting pom.xml back to development.
    
    Parameters:
    
    scmDevelopmentCommitComment - a scmDevelopmentCommitComment object.
  - 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 - a scmId object.
  - setScmPassword
```
public void setScmPassword(String scmPassword)
```
    Set the password for the user interacting with the scm.
    
    Parameters:
    
    scmPassword - a scmPassword object.
  - setScmPrivateKey
```
public void setScmPrivateKey(String scmPrivateKey)
```
    Set private key for an SSH based SCM repository.
    
    Parameters:
    
    scmPrivateKey - a scmPrivateKey object.
  - setScmPrivateKeyPassPhrase
```
public void setScmPrivateKeyPassPhrase(String scmPrivateKeyPassPhrase)
```
    Set pass phrase for the private key.
    
    Parameters:
    
    scmPrivateKeyPassPhrase - a scmPrivateKeyPassPhrase object.
  - setScmRelativePathProjectDirectory
```
public void setScmRelativePathProjectDirectory(String scmRelativePathProjectDirectory)
```
    Set relative path of the project returned by the checkout command.
    
    Parameters:
    
    scmRelativePathProjectDirectory - a scmRelativePathProjectDirectory object.
  - setScmReleaseCommitComment
```
public void setScmReleaseCommitComment(String scmReleaseCommitComment)
```
    Set the SCM commit comment when setting pom.xml to release.
    
    Parameters:
    
    scmReleaseCommitComment - a scmReleaseCommitComment object.
  - 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 - a scmReleaseLabel object.
  - 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 - a scmReleasedPomRevision object
  - setScmRollbackCommitComment
```
public void setScmRollbackCommitComment(String scmRollbackCommitComment)
```
    Set the SCM commit comment when rolling back.
    
    Parameters:
    
    scmRollbackCommitComment - a scmRollbackCommitComment object.
  - setScmShallowClone
```
public void setScmShallowClone(boolean scmShallowClone)
```
    Set get whether to use a shallow clone with no history or a full clone containing the full history during the release.
    
    Parameters:
    
    scmShallowClone - a scmShallowClone object.
  - setScmSignTags
```
public void setScmSignTags(boolean scmSignTags)
```
    Set if the scm provider should use sign tags, for example for git-exe the '--sign' argument would be used.
    
    Parameters:
    
    scmSignTags - a scmSignTags object.
  - 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 - a scmSourceUrl object.
  - 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 - a scmTagBase object.
  - 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 - a scmTagNameFormat object.
  - 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 - a scmUseEditMode object.
  - setScmUsername
```
public void setScmUsername(String scmUsername)
```
    Set the user name to interact with the scm.
    
    Parameters:
    
    scmUsername - a scmUsername object.
  - setSnapshotReleasePluginAllowed
```
public void setSnapshotReleasePluginAllowed(boolean snapshotReleasePluginAllowed)
```
    Set whether a SNAPSHOT of the release plugin is allowed.
    
    Parameters:
    
    snapshotReleasePluginAllowed - a snapshotReleasePluginAllowed object.
  - 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 - a suppressCommitBeforeTagOrBranch object.
  - setUpdateBranchVersions
```
public void setUpdateBranchVersions(boolean updateBranchVersions)
```
    Set whether to update branch POM versions.
    
    Parameters:
    
    updateBranchVersions - a updateBranchVersions object.
  - setUpdateDependencies
```
public void setUpdateDependencies(boolean updateDependencies)
```
    Set if updateDependencies is false, dependencies version won't be updated to the next development version.
    
    Parameters:
    
    updateDependencies - a updateDependencies object.
  - setUpdateVersionsToSnapshot
```
public void setUpdateVersionsToSnapshot(boolean updateVersionsToSnapshot)
```
    Set whether to update branch versions to SNAPSHOT.
    
    Parameters:
    
    updateVersionsToSnapshot - a updateVersionsToSnapshot object.
  - setUpdateWorkingCopyVersions
```
public void setUpdateWorkingCopyVersions(boolean updateWorkingCopyVersions)
```
    Set whether to update working copy POM versions.
    
    Parameters:
    
    updateWorkingCopyVersions - a updateWorkingCopyVersions object.
  - 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 - a useReleaseProfile object.
  - setWaitBeforeTagging
```
public void setWaitBeforeTagging(int waitBeforeTagging)
```
    Set wait the specified number of seconds before creating a tag.
    
    Parameters:
    
    waitBeforeTagging - a waitBeforeTagging object.
  - setWorkItem
```
public void setWorkItem(String workItem)
```
    Set some SCMs may require a Work Item or a Task to allow the changes to be pushed or delivered. This field allows you to specify that Work Item or Task. It is optional, and only relevant if pushChanges is true.
    
    Parameters:
    
    workItem - a workItem object.
  - setWorkingDirectory
```
public void setWorkingDirectory(String workingDirectory)
```
    Set the directory where the release is performed.
    
    Parameters:
    
    workingDirectory - a workingDirectory object.
  - getProjectReleaseVersion
```
public String getProjectReleaseVersion(String projectId)
```
  - addReleaseVersion
```
public void addReleaseVersion(String projectId,
                              String version)
```
    Method addReleaseVersion.
    
    Parameters:
    
    projectId -
    
    version -
  - getProjectDevelopmentVersion
```
public String getProjectDevelopmentVersion(String projectId)
```
  - addDevelopmentVersion
```
public void addDevelopmentVersion(String projectId,
                                  String version)
```
    Method addDevelopmentVersion.
    
    Parameters:
    
    projectId -
    
    version -
  - getOriginalScmInfo
```
public org.apache.maven.model.Scm getOriginalScmInfo(String id)
```
    Method getOriginalScmInfo.
    
    Returns:
    
    Scm
  - hasOriginalScmInfo
```
public boolean hasOriginalScmInfo(String id)
```
    Method hasOriginalScmInfo.
    
    Returns:
    
    map contains
  - addOriginalScmInfo
```
public void addOriginalScmInfo(String key,
                               org.apache.maven.model.Scm value)
```
    Method addOriginalScmInfo.
    
    Parameters:
    
    key -
    
    value -
  - getProjectOriginalVersion
```
public String getProjectOriginalVersion(String projectId)
```
  - addOriginalVersion
```
public void addOriginalVersion(String projectId,
                               String version)
```
  - 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.
  - getDependencyOriginalVersion
```
public String getDependencyOriginalVersion(String artifactConflictId)
```
    Retrieve the original version for the resolved snapshot dependency.
  - addDependencyOriginalVersion
```
public void addDependencyOriginalVersion(String dependencyKey,
                                         String version)
```
  - addDependencyReleaseVersion
```
public void addDependencyReleaseVersion(String dependencyKey,
                                        String version)
```
  - addDependencyDevelopmentVersion
```
public void addDependencyDevelopmentVersion(String dependencyKey,
                                            String version)
```
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class ModelloReleaseDescriptor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ModelloReleaseDescriptor

Method Detail

addActivateProfile

addCheckModificationExclude

getActivateProfiles

getAdditionalArguments

getAutoResolveSnapshots

getCheckModificationExcludes

getCheckoutDirectory

getCompletedPhase

getCompletionGoals

getDefaultDevelopmentVersion

getDefaultReleaseVersion

getDescription

getLineSeparator

getModelEncoding

getName

getPerformGoals

getPomFileName

getPreparationGoals

getProjectNamingPolicyId

getProjectVersionPolicyConfig

getProjectVersionPolicyId

getReleaseStrategyId

getScmBranchBase

getScmBranchCommitComment

getScmCommentPrefix

getScmDevelopmentCommitComment

getScmId

getScmPassword

getScmPrivateKey

getScmPrivateKeyPassPhrase

getScmRelativePathProjectDirectory

getScmReleaseCommitComment

getScmReleaseLabel

getScmReleasedPomRevision

getScmRollbackCommitComment

getScmSourceUrl

getScmTagBase

getScmTagNameFormat

getScmUsername

getWaitBeforeTagging

getWorkItem

getWorkingDirectory

isAddSchema

isAllowTimestampedSnapshots

isAutoVersionSubmodules

isBranchCreation

isCommitByProject

isGenerateReleasePoms

isInteractive

isLocalCheckout

isPinExternals

isPushChanges

isRemoteTagging

isScmShallowClone

isScmSignTags

isScmUseEditMode

isSnapshotReleasePluginAllowed

isSuppressCommitBeforeTagOrBranch

isUpdateBranchVersions

isUpdateDependencies

isUpdateVersionsToSnapshot

isUpdateWorkingCopyVersions

isUseReleaseProfile

removeActivateProfile

removeCheckModificationExclude

setActivateProfiles

setAddSchema

setAdditionalArguments

setAllowTimestampedSnapshots

setAutoResolveSnapshots

setAutoVersionSubmodules

setBranchCreation

setCheckModificationExcludes