Package 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

Constructor Summary

Constructors

Constructor	Description
MailingList()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

MailingList

public MailingList()

Method Detail

addOtherArchive

public void addOtherArchive(String string)

Method addOtherArchive.

Parameters:

string - a string object.

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 - a key object.

Returns:

InputLocation

getName

public String getName()

Get the name of the mailing list.

Returns:

String

getOtherArchives

public List<String> getOtherArchives()

Method getOtherArchives.

Returns:

List

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.

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 - a string object.

setArchive

public void setArchive(String archive)

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

Parameters:

archive - a archive object.

setName

public void setName(String name)

Set the name of the mailing list.

Parameters:

name - a name object.

setOtherArchives

public void setOtherArchives(List<String> otherArchives)

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

Parameters:

otherArchives - a otherArchives object.

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 - a post object.

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 - a subscribe object.

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 - a unsubscribe object.

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()