Class ModelloReleaseDescriptor

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:

  • Field Details

    • name

      private String name
      The name of this release configuration .

    • description

      private String description
      The description of this release configuration .

    • ScmCommentPrefix

      private String ScmCommentPrefix
      The prefix of SCM modification messages .

    • scmReleaseCommitComment

      private String scmReleaseCommitComment
      The SCM commit comment when setting pom.xml to release .

    • scmDevelopmentCommitComment

      private String scmDevelopmentCommitComment
      The SCM commit comment when setting pom.xml back to development .

    • scmBranchCommitComment

      private String scmBranchCommitComment
      The SCM commit comment when branching .

    • scmRollbackCommitComment

      private String scmRollbackCommitComment
      The SCM commit comment when rolling back .

    • scmSourceUrl

      private String scmSourceUrl
      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 .

    • scmTagBase

      private String scmTagBase
      Where you are going to put your tagged sources Example https://svn.apache.org/repos/asf/maven/plugins/tags .

    • scmBranchBase

      private String scmBranchBase
      Where you are going to put your branched sources Example https://svn.apache.org/repos/asf/maven/plugins/branches .

    • scmReleaseLabel

      private String scmReleaseLabel
      tag or branch name: the identifier for the tag/branch. Example: maven-release-plugin-2.0 .

    • scmId

      private String scmId
      The id can be used to get the credentials by the server-id from the settings.xml .

    • scmUsername

      private String scmUsername
      The user name to interact with the scm .

    • scmPassword

      private String scmPassword
      The password for the user interacting with the scm .

    • scmPrivateKey

      private String scmPrivateKey
      Private key for an SSH based SCM repository.

    • scmPrivateKeyPassPhrase

      private String scmPrivateKeyPassPhrase
      Pass phrase for the private key.

    • scmUseEditMode

      private boolean scmUseEditMode
      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.

    • scmRelativePathProjectDirectory

      private String scmRelativePathProjectDirectory
      Relative path of the project returned by the checkout command.

    • updateDependencies

      private boolean updateDependencies
      If updateDependencies is false, dependencies version won't be updated to the next development version.

    • useReleaseProfile

      private boolean useReleaseProfile
      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.

    • activateProfiles

      private List<String> activateProfiles
      Field activateProfiles.

    • workingDirectory

      private String workingDirectory
      The directory where the release is performed.

    • checkoutDirectory

      private String checkoutDirectory
      The directory where the tag will be checked out.

    • completedPhase

      private String completedPhase
      The last completed phase.

    • addSchema

      private boolean addSchema
      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.

    • generateReleasePoms

      private boolean generateReleasePoms
      Whether to generate release POMs.

    • autoVersionSubmodules

      private boolean autoVersionSubmodules
      Whether to use the parent pom version for submodule versions.

    • interactive

      private boolean interactive
      Whether the release process is interactive and the release manager should be prompted to confirm values, or whether the defaults are used regardless.

    • snapshotReleasePluginAllowed

      private boolean snapshotReleasePluginAllowed
      Whether a SNAPSHOT of the release plugin is allowed.

    • additionalArguments

      private String additionalArguments
      Additional arguments to pass to any executed Maven process.

    • pomFileName

      private String pomFileName
      The file name of the POM to pass to any executed Maven process.

    • checkModificationExcludes

      private List<String> checkModificationExcludes
      Field checkModificationExcludes.

    • preparationGoals

      private String preparationGoals
      The goals to execute in preparation for the release.

    • completionGoals

      private String completionGoals
      The goals to execute in on completion of preparation for the release.

    • performGoals

      private String performGoals
      The goals to execute in perform phase for the release.

    • commitByProject

      private boolean commitByProject
      The commits must be done by modules or not. Set it to true in case of flat directory structure.

    • branchCreation

      private boolean branchCreation
      Whether to create a branch instead of do a release.

    • updateBranchVersions

      private boolean updateBranchVersions
      Whether to update branch POM versions.

    • updateWorkingCopyVersions

      private boolean updateWorkingCopyVersions
      Whether to update working copy POM versions.

    • updateVersionsToSnapshot

      private boolean updateVersionsToSnapshot
      Whether to update branch versions to SNAPSHOT.

    • suppressCommitBeforeTagOrBranch

      private boolean suppressCommitBeforeTagOrBranch
      Whether to suppress a commit of changes to the working copy before a tag or branch is created.

    • waitBeforeTagging

      private int waitBeforeTagging
      Wait the specified number of seconds before creating a tag.

    • allowTimestampedSnapshots

      private boolean allowTimestampedSnapshots
      Should timestamped SNAPSHOT dependencies be allowed? Default is to fail when any SNAPSHOT dependency is found.

    • defaultReleaseVersion

      private String defaultReleaseVersion
      Default version to use for the tagged release or the new branch.

    • defaultDevelopmentVersion

      private String defaultDevelopmentVersion
      Default version to use for new working copy.

    • projectVersionPolicyId

      private String projectVersionPolicyId
      The role-hint for the VersionPolicy implementation used to calculate the project versions.

    • projectNamingPolicyId

      private String projectNamingPolicyId
      The role-hint for the NamingPolicy implementation used to calculate the project branch and tag names.

    • releaseStrategyId

      private String releaseStrategyId
      The role-hint for the release Strategy implementation.

    • remoteTagging

      private boolean remoteTagging
      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) .

    • scmReleasedPomRevision

      private String scmReleasedPomRevision
      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.

    • pushChanges

      private boolean pushChanges
      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.

    • localCheckout

      private boolean localCheckout
      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!

    • scmTagNameFormat

      private String scmTagNameFormat
      Specifies the format for generating a tag name. Property expansion is used with the optional prefix of project, where properties are delimited with @{ and } .

    • workItem

      private String workItem
      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.

    • modelEncoding

      private String modelEncoding
      Field modelEncoding.

    • resolvedSnapshotDependencies

      private Map<String, ReleaseStageVersions> resolvedSnapshotDependencies
      Field resolvedSnapshotDependencies.

    • projectVersions

      private Map<String, ReleaseStageVersions> projectVersions
      Field projectVersions

    • originalScmInfo

      private Map<String, org.apache.maven.model.Scm> originalScmInfo
      Field originalScmInfo.

  • Constructor Details

    • ModelloReleaseDescriptor

      public ModelloReleaseDescriptor()

  • Method Details

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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.

    • 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.

    • 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.

    • 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.

    • 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 (http://jira.codehaus.org/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.

    • 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.

    • getProjectVersions

      Map<String, ReleaseStageVersions> getProjectVersions()

    • getOriginalScmInfo

      Map<String, org.apache.maven.model.Scm> getOriginalScmInfo()

    • getResolvedSnapshotDependencies

      Map<String, ReleaseStageVersions> getResolvedSnapshotDependencies()
      Method getResolvedSnapshotDependencies.
      Returns:
      Map

    • getProjectReleaseVersion

      public String getProjectReleaseVersion(String projectId)

    • addReleaseVersion

      public void addReleaseVersion(String projectId, String version)
      Method addReleaseVersion.
      Parameters:
      key -
      value -

    • getProjectDevelopmentVersion

      public String getProjectDevelopmentVersion(String projectId)

    • addDevelopmentVersion

      public void addDevelopmentVersion(String projectId, String version)
      Method addDevelopmentVersion.
      Parameters:
      key -
      value -

    • getOriginalScmInfo

      public org.apache.maven.model.Scm getOriginalScmInfo(String id)
      Method getOriginalScmInfo.
      Returns:
      Map

    • 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)

    • computeIfAbsent

      private static ReleaseStageVersions computeIfAbsent(Map<String, ReleaseStageVersions> map, String key)

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • compareScmCollections

      private boolean compareScmCollections(Map<String, org.apache.maven.model.Scm> that)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object