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