|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.maven.shared.release.config.ReleaseDescriptor
public class ReleaseDescriptor
null
Field Summary | |
---|---|
static java.lang.String |
DEVELOPMENT_KEY
|
static java.lang.String |
ORIGINAL_VERSION
|
static java.lang.String |
RELEASE_KEY
|
Constructor Summary | |
---|---|
ReleaseDescriptor()
|
Method Summary | |
---|---|
void |
addDevelopmentVersion(java.lang.Object key,
java.lang.String value)
Method addDevelopmentVersion |
void |
addOriginalScmInfo(java.lang.Object key,
java.lang.String value)
Method addOriginalScmInfo |
void |
addReleaseVersion(java.lang.Object key,
java.lang.String value)
Method addReleaseVersion |
void |
addResolvedSnapshotDependency(java.lang.Object key,
java.lang.String value)
Method addResolvedSnapshotDependency |
boolean |
equals(java.lang.Object obj)
|
java.lang.String |
getAdditionalArguments()
Get Additional arguments to pass to any executed Maven process. |
java.lang.String |
getCheckoutDirectory()
Get The directory where the tag will be checked out. |
java.lang.String |
getCompletedPhase()
Get The last completed phase. |
java.lang.String |
getDefaultDevelopmentVersion()
Get Default version to use for new working copy. |
java.lang.String |
getDefaultReleaseVersion()
Get Default version to use for the tagged release or the new branch. |
java.lang.String |
getDependencyDevelopmentVersion(java.lang.String artifactConflictId)
Retrieve the release version for the resolved snapshot dependency. |
java.lang.String |
getDependencyReleaseVersion(java.lang.String artifactConflictId)
Retrieve the release version for the resolved snapshot dependency. |
java.lang.String |
getDescription()
Get The description of this release configuration |
java.util.Map |
getDevelopmentVersions()
Method getDevelopmentVersions |
java.lang.String |
getModelEncoding()
|
java.lang.String |
getName()
Get The name of this release configuration |
java.util.Map |
getOriginalScmInfo()
Method getOriginalScmInfo |
java.util.Map |
getOriginalVersions(java.util.List reactorProjects)
Retrieve the original version map, before transformation, keyed by project's versionless identifier. |
java.lang.String |
getPerformGoals()
Get The goals to execute in perform phase for the release. |
java.lang.String |
getPomFileName()
Get The file name of the POM to pass to any executed Maven process. |
java.lang.String |
getPreparationGoals()
Get The goals to execute in preparation for the release. |
java.util.Map |
getReleaseVersions()
Method getReleaseVersions |
java.util.Map |
getResolvedSnapshotDependencies()
Method getResolvedSnapshotDependencies |
java.lang.String |
getScmCommentPrefix()
Get The prefix of SCM modification messages |
java.lang.String |
getScmPassword()
Get The password for the user interacting with the scm |
java.lang.String |
getScmPrivateKey()
Get Private key for an SSH based SCM repository. |
java.lang.String |
getScmPrivateKeyPassPhrase()
Get Pass phrase for the private key. |
java.lang.String |
getScmRelativePathProjectDirectory()
Get Relative path of the project returned by the checkout command. |
java.lang.String |
getScmReleaseLabel()
Get tag name: the identifier for the tag. |
java.lang.String |
getScmSourceUrl()
Get This is a MavenSCM of where you're going to get the sources to make the release with. |
java.lang.String |
getScmTagBase()
Get Where you are going to put your tagged sources Example https://svn.apache.org/repos/asf/maven/plugins/tags |
java.lang.String |
getScmUsername()
Get The user name to interact with the scm |
java.lang.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 verstions. |
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 |
isScmUseEditMode()
Get Whether to use edit mode when making SCM modifications. |
boolean |
isSnapshotReleasePluginAllowed()
Get Whether a SNAPSHOT of the release plugin is allowed. |
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(java.lang.String projectId,
java.lang.String nextVersion)
Map a given project to a specified version from when it is incremented and placed back into development. |
void |
mapOriginalScmInfo(java.lang.String projectId,
org.apache.maven.model.Scm scm)
Map a given project to a specified set of SCM information. |
void |
mapReleaseVersion(java.lang.String projectId,
java.lang.String nextVersion)
Map a given project to a specified version from when it is released. |
void |
mapResolvedSnapshotDependencies(java.lang.String artifactName,
java.lang.String releaseVersion,
java.lang.String developmentVersion)
Map a given snapshot dependency to a specified version from when it is released. |
void |
setAdditionalArguments(java.lang.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 verstions. |
void |
setBranchCreation(boolean branchCreation)
Set Whether to create a branch instead of do a release. |
void |
setCheckoutDirectory(java.lang.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(java.lang.String completedPhase)
Set The last completed phase. |
void |
setDefaultDevelopmentVersion(java.lang.String defaultDevelopmentVersion)
Set Default version to use for new working copy. |
void |
setDefaultReleaseVersion(java.lang.String defaultReleaseVersion)
Set Default version to use for the tagged release or the new branch. |
void |
setDescription(java.lang.String description)
Set The description of this release configuration |
void |
setDevelopmentVersions(java.util.Map developmentVersions)
Set A map of projects to versions to use when moving the given projects back into devlopment 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 |
setModelEncoding(java.lang.String modelEncoding)
|
void |
setName(java.lang.String name)
Set The name of this release configuration |
void |
setOriginalScmInfo(java.util.Map originalScmInfo)
Set A map of projects to original SCM information. |
void |
setPerformGoals(java.lang.String performGoals)
Set The goals to execute in perform phase for the release. |
void |
setPomFileName(java.lang.String pomFileName)
Set The file name of the POM to pass to any executed Maven process. |
void |
setPreparationGoals(java.lang.String preparationGoals)
Set The goals to execute in preparation for the release. |
void |
setReleaseVersions(java.util.Map releaseVersions)
Set A map of projects to versions to use when releasing the given projects. |
void |
setResolvedSnapshotDependencies(java.util.Map resolvedSnapshotDependencies)
Set A map of resolved snapshot dependencies versions. |
void |
setScmCommentPrefix(java.lang.String ScmCommentPrefix)
Set The prefix of SCM modification messages |
void |
setScmPassword(java.lang.String scmPassword)
Set The password for the user interacting with the scm |
void |
setScmPrivateKey(java.lang.String scmPrivateKey)
Set Private key for an SSH based SCM repository. |
void |
setScmPrivateKeyPassPhrase(java.lang.String scmPrivateKeyPassPhrase)
Set Pass phrase for the private key. |
void |
setScmRelativePathProjectDirectory(java.lang.String scmRelativePathProjectDirectory)
Set Relative path of the project returned by the checkout command. |
void |
setScmReleaseLabel(java.lang.String scmReleaseLabel)
Set tag name: the identifier for the tag. |
void |
setScmSourceUrl(java.lang.String scmSourceUrl)
Set This is a MavenSCM of where you're going to get the sources to make the release with. |
void |
setScmTagBase(java.lang.String scmTagBase)
Set Where you are going to put your tagged sources Example https://svn.apache.org/repos/asf/maven/plugins/tags |
void |
setScmUseEditMode(boolean scmUseEditMode)
Set Whether to use edit mode when making SCM modifications. |
void |
setScmUsername(java.lang.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 |
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 |
setWorkingDirectory(java.lang.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 |
---|
public static final java.lang.String DEVELOPMENT_KEY
public static final java.lang.String RELEASE_KEY
public static final java.lang.String ORIGINAL_VERSION
Constructor Detail |
---|
public ReleaseDescriptor()
Method Detail |
---|
public void addDevelopmentVersion(java.lang.Object key, java.lang.String value)
key
- value
- public void addOriginalScmInfo(java.lang.Object key, java.lang.String value)
key
- value
- public void addReleaseVersion(java.lang.Object key, java.lang.String value)
key
- value
- public void addResolvedSnapshotDependency(java.lang.Object key, java.lang.String value)
key
- value
- public java.lang.String getAdditionalArguments()
public java.lang.String getCheckoutDirectory()
public java.lang.String getCompletedPhase()
public java.lang.String getDefaultDevelopmentVersion()
public java.lang.String getDefaultReleaseVersion()
public java.lang.String getDescription()
public java.util.Map getDevelopmentVersions()
public java.lang.String getName()
public java.util.Map getOriginalScmInfo()
public java.lang.String getPerformGoals()
public java.lang.String getPomFileName()
public java.lang.String getPreparationGoals()
public java.util.Map getReleaseVersions()
public java.util.Map getResolvedSnapshotDependencies()
public java.lang.String getScmCommentPrefix()
public java.lang.String getScmPassword()
public java.lang.String getScmPrivateKey()
public java.lang.String getScmPrivateKeyPassPhrase()
public java.lang.String getScmRelativePathProjectDirectory()
public java.lang.String getScmReleaseLabel()
public java.lang.String getScmSourceUrl()
public java.lang.String getScmTagBase()
public java.lang.String getScmUsername()
public java.lang.String getWorkingDirectory()
public boolean isAddSchema()
false
then the root element will
remain untouched.
public boolean isAllowTimestampedSnapshots()
public boolean isAutoVersionSubmodules()
public boolean isBranchCreation()
public boolean isCommitByProject()
public boolean isGenerateReleasePoms()
public boolean isInteractive()
public boolean isScmUseEditMode()
public boolean isSnapshotReleasePluginAllowed()
public boolean isUpdateBranchVersions()
public boolean isUpdateDependencies()
public boolean isUpdateVersionsToSnapshot()
public boolean isUpdateWorkingCopyVersions()
public boolean isUseReleaseProfile()
public void setAddSchema(boolean addSchema)
false
then the root element will
remain untouched.
addSchema
- public void setAdditionalArguments(java.lang.String additionalArguments)
additionalArguments
- public void setAllowTimestampedSnapshots(boolean allowTimestampedSnapshots)
allowTimestampedSnapshots
- public void setAutoVersionSubmodules(boolean autoVersionSubmodules)
autoVersionSubmodules
- public void setBranchCreation(boolean branchCreation)
branchCreation
- public void setCheckoutDirectory(java.lang.String checkoutDirectory)
checkoutDirectory
- public void setCommitByProject(boolean commitByProject)
commitByProject
- public void setCompletedPhase(java.lang.String completedPhase)
completedPhase
- public void setDefaultDevelopmentVersion(java.lang.String defaultDevelopmentVersion)
defaultDevelopmentVersion
- public void setDefaultReleaseVersion(java.lang.String defaultReleaseVersion)
defaultReleaseVersion
- public void setDescription(java.lang.String description)
description
- public void setDevelopmentVersions(java.util.Map developmentVersions)
developmentVersions
- public void setGenerateReleasePoms(boolean generateReleasePoms)
generateReleasePoms
- public void setInteractive(boolean interactive)
interactive
- public void setName(java.lang.String name)
name
- public void setOriginalScmInfo(java.util.Map originalScmInfo)
originalScmInfo
- public void setPerformGoals(java.lang.String performGoals)
performGoals
- public void setPomFileName(java.lang.String pomFileName)
pomFileName
- public void setPreparationGoals(java.lang.String preparationGoals)
preparationGoals
- public void setReleaseVersions(java.util.Map releaseVersions)
releaseVersions
- public void setResolvedSnapshotDependencies(java.util.Map resolvedSnapshotDependencies)
resolvedSnapshotDependencies
- public void setScmCommentPrefix(java.lang.String ScmCommentPrefix)
ScmCommentPrefix
- public void setScmPassword(java.lang.String scmPassword)
scmPassword
- public void setScmPrivateKey(java.lang.String scmPrivateKey)
scmPrivateKey
- public void setScmPrivateKeyPassPhrase(java.lang.String scmPrivateKeyPassPhrase)
scmPrivateKeyPassPhrase
- public void setScmRelativePathProjectDirectory(java.lang.String scmRelativePathProjectDirectory)
scmRelativePathProjectDirectory
- public void setScmReleaseLabel(java.lang.String scmReleaseLabel)
scmReleaseLabel
- public void setScmSourceUrl(java.lang.String scmSourceUrl)
scmSourceUrl
- public void setScmTagBase(java.lang.String scmTagBase)
scmTagBase
- public void setScmUseEditMode(boolean scmUseEditMode)
scmUseEditMode
- public void setScmUsername(java.lang.String scmUsername)
scmUsername
- public void setSnapshotReleasePluginAllowed(boolean snapshotReleasePluginAllowed)
snapshotReleasePluginAllowed
- public void setUpdateBranchVersions(boolean updateBranchVersions)
updateBranchVersions
- public void setUpdateDependencies(boolean updateDependencies)
updateDependencies
- public void setUpdateVersionsToSnapshot(boolean updateVersionsToSnapshot)
updateVersionsToSnapshot
- public void setUpdateWorkingCopyVersions(boolean updateWorkingCopyVersions)
updateWorkingCopyVersions
- public void setUseReleaseProfile(boolean useReleaseProfile)
useReleaseProfile
- public void setWorkingDirectory(java.lang.String workingDirectory)
workingDirectory
- public void mapResolvedSnapshotDependencies(java.lang.String artifactName, java.lang.String releaseVersion, java.lang.String developmentVersion)
public void mapReleaseVersion(java.lang.String projectId, java.lang.String nextVersion)
projectId
- the project's group and artifact IDnextVersion
- the version to map topublic void mapDevelopmentVersion(java.lang.String projectId, java.lang.String nextVersion)
projectId
- the project's group and artifact IDnextVersion
- the version to map topublic void mapOriginalScmInfo(java.lang.String projectId, org.apache.maven.model.Scm scm)
projectId
- the project's group and artifact IDscm
- the original SCM information to storepublic java.util.Map getOriginalVersions(java.util.List reactorProjects)
reactorProjects
- The reactor projects.
public java.lang.String getDependencyDevelopmentVersion(java.lang.String artifactConflictId)
public java.lang.String getDependencyReleaseVersion(java.lang.String artifactConflictId)
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public void setModelEncoding(java.lang.String modelEncoding)
public java.lang.String getModelEncoding()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |