Package org.apache.maven.model
Class MailingList
java.lang.Object
org.apache.maven.model.MailingList
- All Implemented Interfaces:
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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate String
The link to a URL where you can browse the mailing list archive.private InputLocation
Field archiveLocation.private InputLocation
Field location.private Map<Object,
InputLocation> Field locations.private String
The name of the mailing list.private InputLocation
Field nameLocation.Field otherArchives.private InputLocation
Field otherArchivesLocation.private String
The email address or link that can be used to post to the mailing list.private InputLocation
Field postLocation.private String
The email address or link that can be used to subscribe to the mailing list.private InputLocation
Field subscribeLocation.private String
The email address or link that can be used to unsubscribe to the mailing list.private InputLocation
Field unsubscribeLocation. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addOtherArchive
(String string) Method addOtherArchive.clone()
Method clone.Get the link to a URL where you can browse the mailing list archive.getLocation
(Object key) Gets the location of the specified field in the input source.getName()
Get the name of the mailing list.Method getOtherArchives.private InputLocation
getOtherLocation
(Object key) getPost()
Get the email address or link that can be used to post to the mailing list.Get the email address or link that can be used to subscribe to the mailing list.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
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
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.toString()
-
Field Details
-
name
The name of the mailing list. -
subscribe
The email address or link that can be used to subscribe to the mailing list. If this is an email address, amailto:
link will automatically be created when the documentation is created. -
unsubscribe
The email address or link that can be used to unsubscribe to the mailing list. If this is an email address, amailto:
link will automatically be created when the documentation is created. -
post
The email address or link that can be used to post to the mailing list. If this is an email address, amailto:
link will automatically be created when the documentation is created. -
archive
The link to a URL where you can browse the mailing list archive. -
otherArchives
Field otherArchives. -
locations
Field locations. -
location
Field location. -
nameLocation
Field nameLocation. -
subscribeLocation
Field subscribeLocation. -
unsubscribeLocation
Field unsubscribeLocation. -
postLocation
Field postLocation. -
archiveLocation
Field archiveLocation. -
otherArchivesLocation
Field otherArchivesLocation.
-
-
Constructor Details
-
MailingList
public MailingList()
-
-
Method Details
-
addOtherArchive
Method addOtherArchive.- Parameters:
string
- a string object.
-
clone
Method clone. -
getArchive
Get the link to a URL where you can browse the mailing list archive.- Returns:
- String
-
getLocation
Description copied from interface:InputLocationTracker
Gets the location of the specified field in the input source.- Specified by:
getLocation
in interfaceInputLocationTracker
- Parameters:
key
- a key object.- Returns:
- InputLocation
-
getName
Get the name of the mailing list.- Returns:
- String
-
getOtherArchives
Method getOtherArchives.- Returns:
- List
-
setLocation
Description copied from interface:InputLocationTracker
Sets the location of the specified field.- Specified by:
setLocation
in interfaceInputLocationTracker
- Parameters:
key
- a key object.location
- a location object.
-
setOtherLocation
- Parameters:
key
- a key object.location
- a location object.
-
getOtherLocation
- Parameters:
key
- a key object.- Returns:
- InputLocation
-
getPost
Get the email address or link that can be used to post to the mailing list. If this is an email address, amailto:
link will automatically be created when the documentation is created.- Returns:
- String
-
getSubscribe
Get the email address or link that can be used to subscribe to the mailing list. If this is an email address, amailto:
link will automatically be created when the documentation is created.- Returns:
- String
-
getUnsubscribe
Get the email address or link that can be used to unsubscribe to the mailing list. If this is an email address, amailto:
link will automatically be created when the documentation is created.- Returns:
- String
-
removeOtherArchive
Method removeOtherArchive.- Parameters:
string
- a string object.
-
setArchive
Set the link to a URL where you can browse the mailing list archive.- Parameters:
archive
- a archive object.
-
setName
Set the name of the mailing list.- Parameters:
name
- a name object.
-
setOtherArchives
Set the link to alternate URLs where you can browse the list archive.- Parameters:
otherArchives
- a otherArchives object.
-
setPost
Set the email address or link that can be used to post to the mailing list. If this is an email address, amailto:
link will automatically be created when the documentation is created.- Parameters:
post
- a post object.
-
setSubscribe
Set the email address or link that can be used to subscribe to the mailing list. If this is an email address, amailto:
link will automatically be created when the documentation is created.- Parameters:
subscribe
- a subscribe object.
-
setUnsubscribe
Set the email address or link that can be used to unsubscribe to the mailing list. If this is an email address, amailto:
link will automatically be created when the documentation is created.- Parameters:
unsubscribe
- a unsubscribe object.
-
toString
-