org.apache.maven.model
Class MailingList

java.lang.Object
  org.apache.maven.model.MailingList

All Implemented Interfaces:

Serializable, Cloneable, InputLocationTracker

public class MailingList
extends Object
implements Serializable, 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

MailingList

public MailingList()

addOtherArchive

public void addOtherArchive(String string)

Method addOtherArchive.

Parameters:

string -

clone

public MailingList clone()

Method clone.

Overrides:

clone in class Object

Returns:

MailingList

getArchive

public String getArchive()

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

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 -

Returns:

InputLocation

getName

public String getName()

Get the name of the mailing list.

Returns:

String

getOtherArchives

public List<String> getOtherArchives()

Method getOtherArchives.

Returns:

List

getPost

public 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 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 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(String string)

Method removeOtherArchive.

Parameters:

string -

setArchive

public void setArchive(String archive)

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

Parameters:

archive -

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 -

location -

setName

public void setName(String name)

Set the name of the mailing list.

Parameters:

name -

setOtherArchives

public void setOtherArchives(List<String> otherArchives)

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

Parameters:

otherArchives -

setPost

public void setPost(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(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(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 -