Class 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
    • Constructor Summary

      Constructors 
      Constructor Description
      MailingList()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method 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 setOtherLocation​(java.lang.Object key, InputLocation location)  
      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.
      java.lang.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​(java.lang.String string)
        Method addOtherArchive.
        Parameters:
        string - a string object.
      • 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
      • 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
      • setOtherLocation

        public void setOtherLocation​(java.lang.Object key,
                                     InputLocation location)
        Parameters:
        key - a key object.
        location - a location object.
      • 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 - a string object.
      • setArchive

        public void setArchive​(java.lang.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​(java.lang.String name)
        Set the name of the mailing list.
        Parameters:
        name - a name object.
      • 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 - a otherArchives object.
      • 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 - a post object.
      • 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 - a subscribe object.
      • 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 - a unsubscribe object.
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
        See Also:
        Object.toString()