View Javadoc

1   /*
2    =================== DO NOT EDIT THIS FILE ====================
3    Generated by Modello 1.0.1 on 2009-09-09 03:30:24,
4    any modifications will be overwritten.
5    ==============================================================
6    */
7   
8   package org.apache.maven.model;
9   
10  /**
11   * This element describes all of the mailing lists associated with
12   * a project. The
13   *         auto-generated site references this information.
14   * 
15   * @version $Revision$ $Date$
16   */
17  public class MailingList
18      implements java.io.Serializable
19  {
20  
21        //--------------------------/
22       //- Class/Member Variables -/
23      //--------------------------/
24  
25      /**
26       * 
27       *             
28       *             The name of the mailing list.
29       *             
30       *           
31       */
32      private String name;
33  
34      /**
35       * 
36       *             
37       *             The email address or link that can be used to
38       * subscribe to
39       *             the mailing list.  If this is an email address,
40       * a
41       *             <code>mailto:</code> link will automatically be
42       * created
43       *             when the documentation is created.
44       *             
45       *           
46       */
47      private String subscribe;
48  
49      /**
50       * 
51       *             
52       *             The email address or link that can be used to
53       * unsubscribe to
54       *             the mailing list.  If this is an email address,
55       * a
56       *             <code>mailto:</code> link will automatically be
57       * created
58       *             when the documentation is created.
59       *             
60       *           
61       */
62      private String unsubscribe;
63  
64      /**
65       * 
66       *             
67       *             The email address or link that can be used to
68       * post to
69       *             the mailing list.  If this is an email address,
70       * a
71       *             <code>mailto:</code> link will automatically be
72       * created
73       *             when the documentation is created.
74       *             
75       *           
76       */
77      private String post;
78  
79      /**
80       * The link to a URL where you can browse the mailing list
81       * archive.
82       */
83      private String archive;
84  
85      /**
86       * Field otherArchives.
87       */
88      private java.util.List<String> otherArchives;
89  
90  
91        //-----------/
92       //- Methods -/
93      //-----------/
94  
95      /**
96       * Method addOtherArchive.
97       * 
98       * @param string
99       */
100     public void addOtherArchive( String string )
101     {
102         if ( !(string instanceof String) )
103         {
104             throw new ClassCastException( "MailingList.addOtherArchives(string) parameter must be instanceof " + String.class.getName() );
105         }
106         getOtherArchives().add( string );
107     } //-- void addOtherArchive( String )
108 
109     /**
110      * Get the link to a URL where you can browse the mailing list
111      * archive.
112      * 
113      * @return String
114      */
115     public String getArchive()
116     {
117         return this.archive;
118     } //-- String getArchive()
119 
120     /**
121      * Get the name of the mailing list.
122      * 
123      * @return String
124      */
125     public String getName()
126     {
127         return this.name;
128     } //-- String getName()
129 
130     /**
131      * Method getOtherArchives.
132      * 
133      * @return List
134      */
135     public java.util.List<String> getOtherArchives()
136     {
137         if ( this.otherArchives == null )
138         {
139             this.otherArchives = new java.util.ArrayList<String>();
140         }
141 
142         return this.otherArchives;
143     } //-- java.util.List<String> getOtherArchives()
144 
145     /**
146      * Get the email address or link that can be used to post to
147      *             the mailing list.  If this is an email address,
148      * a
149      *             <code>mailto:</code> link will automatically be
150      * created
151      *             when the documentation is created.
152      * 
153      * @return String
154      */
155     public String getPost()
156     {
157         return this.post;
158     } //-- String getPost()
159 
160     /**
161      * Get the email address or link that can be used to subscribe
162      * to
163      *             the mailing list.  If this is an email address,
164      * a
165      *             <code>mailto:</code> link will automatically be
166      * created
167      *             when the documentation is created.
168      * 
169      * @return String
170      */
171     public String getSubscribe()
172     {
173         return this.subscribe;
174     } //-- String getSubscribe()
175 
176     /**
177      * Get the email address or link that can be used to
178      * unsubscribe to
179      *             the mailing list.  If this is an email address,
180      * a
181      *             <code>mailto:</code> link will automatically be
182      * created
183      *             when the documentation is created.
184      * 
185      * @return String
186      */
187     public String getUnsubscribe()
188     {
189         return this.unsubscribe;
190     } //-- String getUnsubscribe()
191 
192     /**
193      * Method removeOtherArchive.
194      * 
195      * @param string
196      */
197     public void removeOtherArchive( String string )
198     {
199         if ( !(string instanceof String) )
200         {
201             throw new ClassCastException( "MailingList.removeOtherArchives(string) parameter must be instanceof " + String.class.getName() );
202         }
203         getOtherArchives().remove( string );
204     } //-- void removeOtherArchive( String )
205 
206     /**
207      * Set the link to a URL where you can browse the mailing list
208      * archive.
209      * 
210      * @param archive
211      */
212     public void setArchive( String archive )
213     {
214         this.archive = archive;
215     } //-- void setArchive( String )
216 
217     /**
218      * Set the name of the mailing list.
219      * 
220      * @param name
221      */
222     public void setName( String name )
223     {
224         this.name = name;
225     } //-- void setName( String )
226 
227     /**
228      * Set the link to alternate URLs where you can browse the list
229      * archive.
230      * 
231      * @param otherArchives
232      */
233     public void setOtherArchives( java.util.List<String> otherArchives )
234     {
235         this.otherArchives = otherArchives;
236     } //-- void setOtherArchives( java.util.List )
237 
238     /**
239      * Set the email address or link that can be used to post to
240      *             the mailing list.  If this is an email address,
241      * a
242      *             <code>mailto:</code> link will automatically be
243      * created
244      *             when the documentation is created.
245      * 
246      * @param post
247      */
248     public void setPost( String post )
249     {
250         this.post = post;
251     } //-- void setPost( String )
252 
253     /**
254      * Set the email address or link that can be used to subscribe
255      * to
256      *             the mailing list.  If this is an email address,
257      * a
258      *             <code>mailto:</code> link will automatically be
259      * created
260      *             when the documentation is created.
261      * 
262      * @param subscribe
263      */
264     public void setSubscribe( String subscribe )
265     {
266         this.subscribe = subscribe;
267     } //-- void setSubscribe( String )
268 
269     /**
270      * Set the email address or link that can be used to
271      * unsubscribe to
272      *             the mailing list.  If this is an email address,
273      * a
274      *             <code>mailto:</code> link will automatically be
275      * created
276      *             when the documentation is created.
277      * 
278      * @param unsubscribe
279      */
280     public void setUnsubscribe( String unsubscribe )
281     {
282         this.unsubscribe = unsubscribe;
283     } //-- void setUnsubscribe( String )
284 
285 
286 }