org.apache.maven.model

Class MailingList

java.lang.Object

org.apache.maven.model.MailingList

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, InputLocationTracker

public class MailingList
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable, InputLocationTracker

This element describes all of the mailing lists associated with a project. The auto-generated site references this information.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	archive The link to a URL where you can browse the mailing list archive.
private java.util.Map<java.lang.Object,InputLocation>	locations Field locations.
private java.lang.String	name The name of the mailing list.
private java.util.List<java.lang.String>	otherArchives Field otherArchives.
private java.lang.String	post The email address or link that can be used to post to the mailing list.
private java.lang.String	subscribe The email address or link that can be used to subscribe to the mailing list.
private java.lang.String	unsubscribe The email address or link that can be used to unsubscribe to the mailing list.

Constructor Summary

Constructors

Constructor and Description
MailingList()

Method Summary

Modifier and Type	Method and Description
void	addOtherArchive(java.lang.String string) Method addOtherArchive.
MailingList	clone() Method clone.
java.lang.String	getArchive() Get the link to a URL where you can browse the mailing list archive.
InputLocation	getLocation(java.lang.Object key) Gets the location of the specified field in the input source.
java.lang.String	getName() Get the name of the mailing list.
java.util.List<java.lang.String>	getOtherArchives() Method getOtherArchives.
java.lang.String	getPost() Get the email address or link that can be used to post to the mailing list.
java.lang.String	getSubscribe() Get the email address or link that can be used to subscribe to the mailing list.
java.lang.String	getUnsubscribe() Get the email address or link that can be used to unsubscribe to the mailing list.
void	removeOtherArchive(java.lang.String string) Method removeOtherArchive.
void	setArchive(java.lang.String archive) Set the link to a URL where you can browse the mailing list archive.
void	setLocation(java.lang.Object key, InputLocation location) Sets the location of the specified field.
void	setName(java.lang.String name) Set the name of the mailing list.
void	setOtherArchives(java.util.List<java.lang.String> otherArchives) Set the link to alternate URLs where you can browse the list archive.
void	setPost(java.lang.String post) Set the email address or link that can be used to post to the mailing list.
void	setSubscribe(java.lang.String subscribe) Set the email address or link that can be used to subscribe to the mailing list.
void	setUnsubscribe(java.lang.String unsubscribe) Set the email address or link that can be used to unsubscribe to the mailing list.

Methods inherited from class java.lang.Object

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

Field Detail

name

private java.lang.String name

The name of the mailing list.

subscribe

private java.lang.String subscribe

The email address or link that can be used to subscribe to the mailing list. If this is an email address, a mailto: link will automatically be created when the documentation is created.

unsubscribe

private java.lang.String unsubscribe

The email address or link that can be used to unsubscribe to the mailing list. If this is an email address, a mailto: link will automatically be created when the documentation is created.

post

private java.lang.String post

The email address or link that can be used to post to the mailing list. If this is an email address, a mailto: link will automatically be created when the documentation is created.

archive

private java.lang.String archive

The link to a URL where you can browse the mailing list archive.

otherArchives

private java.util.List<java.lang.String> otherArchives

Field otherArchives.

locations

private java.util.Map<java.lang.Object,InputLocation> locations

Field locations.

Constructor Detail

MailingList

public MailingList()

Method Detail

addOtherArchive

public void addOtherArchive(java.lang.String string)

Method addOtherArchive.

Parameters:

string -

clone

public MailingList clone()

Method clone.

Overrides:

clone in class java.lang.Object

Returns:

MailingList

getArchive

public java.lang.String getArchive()

Get the link to a URL where you can browse the mailing list archive.

Returns:

String

getLocation

public InputLocation getLocation(java.lang.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 -

Returns:

InputLocation

getName

public java.lang.String getName()

Get the name of the mailing list.

Returns:

String

getOtherArchives

public java.util.List<java.lang.String> getOtherArchives()

Method getOtherArchives.

Returns:

List

getPost

public java.lang.String getPost()

Get the email address or link that can be used to post to the mailing list. If this is an email address, a mailto: link will automatically be created when the documentation is created.

Returns:

String

getSubscribe

public java.lang.String getSubscribe()

Get the email address or link that can be used to subscribe to the mailing list. If this is an email address, a mailto: link will automatically be created when the documentation is created.

Returns:

String

getUnsubscribe

public java.lang.String getUnsubscribe()

Get the email address or link that can be used to unsubscribe to the mailing list. If this is an email address, a mailto: link will automatically be created when the documentation is created.

Returns:

String

removeOtherArchive

public void removeOtherArchive(java.lang.String string)

Method removeOtherArchive.

Parameters:

string -

setArchive

public void setArchive(java.lang.String archive)

Set the link to a URL where you can browse the mailing list archive.

Parameters:

archive -

setLocation

public void setLocation(java.lang.Object key,
                        InputLocation location)

Description copied from interface: InputLocationTracker

Sets the location of the specified field.

Specified by:

setLocation in interface InputLocationTracker

Parameters:

key -

location -

setName

public void setName(java.lang.String name)

Set the name of the mailing list.

Parameters:

name -

setOtherArchives

public void setOtherArchives(java.util.List<java.lang.String> otherArchives)

Set the link to alternate URLs where you can browse the list archive.

Parameters:

otherArchives -

setPost

public void setPost(java.lang.String post)

Set the email address or link that can be used to post to the mailing list. If this is an email address, a mailto: link will automatically be created when the documentation is created.

Parameters:

post -

setSubscribe

public void setSubscribe(java.lang.String subscribe)

Set the email address or link that can be used to subscribe to the mailing list. If this is an email address, a mailto: link will automatically be created when the documentation is created.

Parameters:

subscribe -

setUnsubscribe

public void setUnsubscribe(java.lang.String unsubscribe)

Set the email address or link that can be used to unsubscribe to the mailing list. If this is an email address, a mailto: link will automatically be created when the documentation is created.

Parameters:

unsubscribe -