org.apache.maven.plugins.release.config
Class ReleaseConfiguration

java.lang.Object
  org.apache.maven.plugins.release.config.ReleaseConfiguration

public class ReleaseConfiguration
extends java.lang.Object

Configuration used for the release.

Author:

Brett Porter

Constructor Summary

ReleaseConfiguration()

Method Summary

boolean	equals(java.lang.Object obj)
java.lang.String	getAdditionalArguments()
java.lang.String	getCompletedPhase()
java.util.Map	getDevelopmentVersions()
java.util.Map	getOriginalScmInfo()
java.util.Map	getOriginalVersions() Retrieve the original version map, before transformation, keyed by project's versionless identifier.
java.lang.String	getPassphrase()
java.lang.String	getPassword()
java.lang.String	getPomFileName()
java.lang.String	getPreparationGoals()
java.lang.String	getPrivateKey()
java.util.List	getReactorProjects()
java.lang.String	getReleaseLabel()
java.util.Map	getReleaseVersions()
org.apache.maven.settings.Settings	getSettings()
java.lang.String	getTagBase()
java.lang.String	getUrl()
java.lang.String	getUsername()
java.io.File	getWorkingDirectory()
int	hashCode()
boolean	isAddSchema()
boolean	isGenerateReleasePoms()
boolean	isInteractive()
boolean	isUseEditMode()
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	merge(ReleaseConfiguration mergeConfiguration) Merge two configurations together.
void	setAdditionalArguments(java.lang.String additionalArguments)
void	setAddSchema(boolean addSchema)
void	setCompletedPhase(java.lang.String completedPhase)
void	setGenerateReleasePoms(boolean generateReleasePoms)
void	setInteractive(boolean interactive)
void	setPassphrase(java.lang.String passphrase)
void	setPassword(java.lang.String password)
void	setPomFileName(java.lang.String pomFileName)
void	setPreparationGoals(java.lang.String preparationGoals)
void	setPrivateKey(java.lang.String privateKey)
void	setReactorProjects(java.util.List reactorProjects)
void	setReleaseLabel(java.lang.String releaseLabel)
void	setSettings(org.apache.maven.settings.Settings settings)
void	setTagBase(java.lang.String tagBase)
void	setUrl(java.lang.String url)
void	setUseEditMode(boolean useEditMode)
void	setUsername(java.lang.String username)
void	setWorkingDirectory(java.io.File workingDirectory)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReleaseConfiguration

public ReleaseConfiguration()

Method Detail

getPreparationGoals

public java.lang.String getPreparationGoals()

setPreparationGoals

public void setPreparationGoals(java.lang.String preparationGoals)

setPomFileName

public void setPomFileName(java.lang.String pomFileName)

getPomFileName

public java.lang.String getPomFileName()

isInteractive

public boolean isInteractive()

setInteractive

public void setInteractive(boolean interactive)

isGenerateReleasePoms

public boolean isGenerateReleasePoms()

getCompletedPhase

public java.lang.String getCompletedPhase()

setCompletedPhase

public void setCompletedPhase(java.lang.String completedPhase)

getSettings

public org.apache.maven.settings.Settings getSettings()

getTagBase

public java.lang.String getTagBase()

getUsername

public java.lang.String getUsername()

getPassword

public java.lang.String getPassword()

getUrl

public java.lang.String getUrl()

getPrivateKey

public java.lang.String getPrivateKey()

getPassphrase

public java.lang.String getPassphrase()

getWorkingDirectory

public java.io.File getWorkingDirectory()

setUrl

public void setUrl(java.lang.String url)

setSettings

public void setSettings(org.apache.maven.settings.Settings settings)

setTagBase

public void setTagBase(java.lang.String tagBase)

setUsername

public void setUsername(java.lang.String username)

setPassword

public void setPassword(java.lang.String password)

setPrivateKey

public void setPrivateKey(java.lang.String privateKey)

setPassphrase

public void setPassphrase(java.lang.String passphrase)

setWorkingDirectory

public void setWorkingDirectory(java.io.File workingDirectory)

getReactorProjects

public java.util.List getReactorProjects()

setReactorProjects

public void setReactorProjects(java.util.List reactorProjects)

isUseEditMode

public boolean isUseEditMode()

isAddSchema

public boolean isAddSchema()

setUseEditMode

public void setUseEditMode(boolean useEditMode)

setAddSchema

public void setAddSchema(boolean addSchema)

setGenerateReleasePoms

public void setGenerateReleasePoms(boolean generateReleasePoms)

getReleaseVersions

public java.util.Map getReleaseVersions()

getDevelopmentVersions

public java.util.Map getDevelopmentVersions()

getOriginalScmInfo

public java.util.Map getOriginalScmInfo()

setReleaseLabel

public void setReleaseLabel(java.lang.String releaseLabel)

getReleaseLabel

public java.lang.String getReleaseLabel()

getAdditionalArguments

public java.lang.String getAdditionalArguments()

setAdditionalArguments

public void setAdditionalArguments(java.lang.String additionalArguments)

merge

public void merge(ReleaseConfiguration mergeConfiguration)

Merge two configurations together. All SCM settings are overridden by the merge configuration, as are the settings and workingDirectory fields. The completedPhase field is used as a default from the merge configuration, but not overridden if it exists.

Parameters:

mergeConfiguration - the configuration to merge into this configuration

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

mapReleaseVersion

public void mapReleaseVersion(java.lang.String projectId,
                              java.lang.String nextVersion)

Map a given project to a specified version from when it is released.

Parameters:

projectId - the project's group and artifact ID

nextVersion - the version to map to

mapDevelopmentVersion

public void mapDevelopmentVersion(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.

Parameters:

projectId - the project's group and artifact ID

nextVersion - the version to map to

mapOriginalScmInfo

public void mapOriginalScmInfo(java.lang.String projectId,
                               org.apache.maven.model.Scm scm)

Map a given project to a specified set of SCM information.

Parameters:

projectId - the project's group and artifact ID

scm - the original SCM information to store

getOriginalVersions

public java.util.Map getOriginalVersions()

Retrieve the original version map, before transformation, keyed by project's versionless identifier.

Returns:

the map of project IDs to versions.