Package org.apache.maven.model

Class DistributionManagement

java.lang.Object

org.apache.maven.model.DistributionManagement

All Implemented Interfaces:

Serializable, Cloneable, InputLocationTracker

public class DistributionManagement
extends Object
implements Serializable, Cloneable, InputLocationTracker

This elements describes all that pertains to distribution for a project. It is primarily used for deployment of artifacts and the site produced by the build.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
DistributionManagement()

Method Summary

Modifier and Type	Method	Description
DistributionManagement	clone()	Method clone.
String	getDownloadUrl()	Get the URL of the project's download page.
InputLocation	getLocation(Object key)	Gets the location of the specified field in the input source.
Relocation	getRelocation()	Get relocation information of the artifact if it has been moved to a new group ID and/or artifact ID.
DeploymentRepository	getRepository()	Get information needed to deploy the artifacts generated by the project to a remote repository.
Site	getSite()	Get information needed for deploying the web site of the project.
DeploymentRepository	getSnapshotRepository()	Get where to deploy snapshots of artifacts to.
String	getStatus()	Get gives the status of this artifact in the remote repository.
void	setDownloadUrl(String downloadUrl)	Set the URL of the project's download page.
void	setLocation(Object key, InputLocation location)	Sets the location of the specified field.
void	setOtherLocation(Object key, InputLocation location)
void	setRelocation(Relocation relocation)	Set relocation information of the artifact if it has been moved to a new group ID and/or artifact ID.
void	setRepository(DeploymentRepository repository)	Set information needed to deploy the artifacts generated by the project to a remote repository.
void	setSite(Site site)	Set information needed for deploying the web site of the project.
void	setSnapshotRepository(DeploymentRepository snapshotRepository)	Set where to deploy snapshots of artifacts to.
void	setStatus(String status)	Set gives the status of this artifact in the remote repository.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DistributionManagement

public DistributionManagement()

Method Detail

clone

public DistributionManagement clone()

Method clone.

Overrides:

clone in class Object

Returns:

DistributionManagement

getDownloadUrl

public String getDownloadUrl()

Get the URL of the project's download page. If not given users will be referred to the homepage given by url. This is given to assist in locating artifacts that are not in the repository due to licensing restrictions.

Returns:

String

getLocation

public InputLocation getLocation(Object key)

Description copied from interface: InputLocationTracker

Gets the location of the specified field in the input source.

Specified by:

getLocation in interface InputLocationTracker

Parameters:

key - a key object.

Returns:

InputLocation

setLocation

public void setLocation(Object key,
                        InputLocation location)

Description copied from interface: InputLocationTracker

Sets the location of the specified field.

Specified by:

setLocation in interface InputLocationTracker

Parameters:

key - a key object.

location - a location object.

setOtherLocation

public void setOtherLocation(Object key,
                             InputLocation location)

Parameters:

key - a key object.

location - a location object.

getRelocation

public Relocation getRelocation()

Get relocation information of the artifact if it has been moved to a new group ID and/or artifact ID.

Returns:

Relocation

getRepository

public DeploymentRepository getRepository()

Get information needed to deploy the artifacts generated by the project to a remote repository.

Returns:

DeploymentRepository

getSite

public Site getSite()

Get information needed for deploying the web site of the project.

Returns:

Site

getSnapshotRepository

public DeploymentRepository getSnapshotRepository()

Get where to deploy snapshots of artifacts to. If not given, it defaults to the repository element.

Returns:

DeploymentRepository

getStatus

public String getStatus()

Get gives the status of this artifact in the remote repository. This must not be set in your local project, as it is updated by tools placing it in the reposiory. Valid values are: none (default), converted (repository manager converted this from an Maven 1 POM), partner (directly synced from a partner Maven 2 repository), deployed (was deployed from a Maven 2 instance), verified (has been hand verified as correct and final).

Returns:

String

setDownloadUrl

public void setDownloadUrl(String downloadUrl)

Set the URL of the project's download page. If not given users will be referred to the homepage given by url. This is given to assist in locating artifacts that are not in the repository due to licensing restrictions.

Parameters:

downloadUrl - a downloadUrl object.

setRelocation

public void setRelocation(Relocation relocation)

Set relocation information of the artifact if it has been moved to a new group ID and/or artifact ID.

Parameters:

relocation - a relocation object.

setRepository

public void setRepository(DeploymentRepository repository)

Set information needed to deploy the artifacts generated by the project to a remote repository.

Parameters:

repository - a repository object.

setSite

public void setSite(Site site)

Set information needed for deploying the web site of the project.

Parameters:

site - a site object.

setSnapshotRepository

public void setSnapshotRepository(DeploymentRepository snapshotRepository)

Set where to deploy snapshots of artifacts to. If not given, it defaults to the repository element.

Parameters:

snapshotRepository - a snapshotRepository object.

setStatus

public void setStatus(String status)

Set gives the status of this artifact in the remote repository. This must not be set in your local project, as it is updated by tools placing it in the reposiory. Valid values are: none (default), converted (repository manager converted this from an Maven 1 POM), partner (directly synced from a partner Maven 2 repository), deployed (was deployed from a Maven 2 instance), verified (has been hand verified as correct and final).

Parameters:

status - a status object.