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