View Javadoc
1   // =================== DO NOT EDIT THIS FILE ====================
2   // Generated by Modello 1.8.1,
3   // any modifications will be overwritten.
4   // ==============================================================
5   
6   package org.apache.maven.plugin.doap.options;
7   
8   /**
9    * Specific ASF DOAP parameters, i.e. ASF options which make DOAP
10   * file ASF compliant.
11   * @see <a
12   * href="http://svn.apache.org/repos/asf/infrastructure/site-tools/trunk/projects/asfext">
13   * http://svn.apache.org/repos/asf/infrastructure/site-tools/trunk/projects/asfext</a>;
14   * @see <a
15   * href="http://projects.apache.org/docs/pmc.html">http://projects.apache.org/docs/pmc.html</a>
16   * @see <a
17   * href="http://projects.apache.org/docs/standards.html">http://projects.apache.org/docs/standards.html</a>
18   * 
19   * @version $Revision$ $Date$
20   */
21  @SuppressWarnings( "all" )
22  public class ASFExtOptions
23      implements java.io.Serializable
24  {
25  
26        //--------------------------/
27       //- Class/Member Variables -/
28      //--------------------------/
29  
30      /**
31       * The ASFext xmlns prefix.<br/>
32       * <b>Default value</b>: asfext.
33       */
34      private String xmlnsPrefix = "asfext";
35  
36      /**
37       * The URI of the ASFext xmlns namespace.<br/>
38       * <b>Default value</b>: http://projects.apache.org/ns/asfext#.
39       */
40      private String xmlnsNamespaceURI = "http://projects.apache.org/ns/asfext#";
41  
42      /**
43       * Flag to use or not the ASF extension in the generated DOAP.
44       */
45      private boolean included = false;
46  
47      /**
48       * The top level element within a file. Optional will be
49       * discovered from POM.<br/>
50       * <b>Default value</b>: ${project.url}
51       * @see <a
52       * href="http://projects.apache.org/docs/pmc.html">http://projects.apache.org/docs/pmc.html</a>
53       */
54      private String pmc = "${project.url}";
55  
56      /**
57       * The name of the PMC, including the 'Apache ', e.g. 'Apache
58       * Forrest'. Optional will be discovered from POM.<br/>
59       * <b>Default value</b>: ${project.name}
60       * @see <a
61       * href="http://projects.apache.org/docs/pmc.html">http://projects.apache.org/docs/pmc.html</a>
62       */
63      private String name = "${project.name}";
64  
65      /**
66       * Every PMC is created by a board resolution with a specific
67       * charter. That charter should be
68       *             listed here as it gives the focus and scope of
69       * the PMC. Optional.
70       * @see <a
71       * href="http://projects.apache.org/docs/pmc.html">http://projects.apache.org/docs/pmc.html</a>
72       */
73      private String charter;
74  
75      /**
76       * This should contain the name of the current PMC chairperson.
77       * Optional.<br/>
78       * <b>Note</b>: it will be discovered from
79       * ${project.developers.roles}
80       * @see <a
81       * href="http://projects.apache.org/docs/pmc.html">http://projects.apache.org/docs/pmc.html</a>
82       */
83      private String chair;
84  
85      /**
86       * Field standards.
87       */
88      private java.util.List<Standard> standards;
89  
90      /**
91       * Field extra.
92       */
93      private java.util.Map<Object, String> extra;
94  
95  
96        //-----------/
97       //- Methods -/
98      //-----------/
99  
100     /**
101      * Method addExtra.
102      * 
103      * @param key
104      * @param value
105      */
106     public void addExtra( Object key, String value )
107     {
108         getExtra().put( key, value );
109     } //-- void addExtra( Object, String )
110 
111     /**
112      * Method addStandard.
113      * 
114      * @param standard
115      */
116     public void addStandard( Standard standard )
117     {
118         getStandards().add( standard );
119     } //-- void addStandard( Standard )
120 
121     /**
122      * Method equals.
123      * 
124      * @param other
125      * @return boolean
126      */
127     public boolean equals( Object other )
128     {
129         if ( this == other )
130         {
131             return true;
132         }
133 
134         if ( !( other instanceof ASFExtOptions ) )
135         {
136             return false;
137         }
138 
139         ASFExtOptions that = (ASFExtOptions) other;
140         boolean result = true;
141 
142         result = result && included == that.included;
143         result = result && ( getPmc() == null ? that.getPmc() == null : getPmc().equals( that.getPmc() ) );
144         result = result && ( getName() == null ? that.getName() == null : getName().equals( that.getName() ) );
145         result = result && ( getCharter() == null ? that.getCharter() == null : getCharter().equals( that.getCharter() ) );
146         result = result && ( getChair() == null ? that.getChair() == null : getChair().equals( that.getChair() ) );
147         result = result && ( getExtra() == null ? that.getExtra() == null : getExtra().equals( that.getExtra() ) );
148 
149         return result;
150     } //-- boolean equals( Object )
151 
152     /**
153      * Get this should contain the name of the current PMC
154      * chairperson. Optional.<br/>
155      * <b>Note</b>: it will be discovered from
156      * ${project.developers.roles}
157      * @see <a
158      * href="http://projects.apache.org/docs/pmc.html">http://projects.apache.org/docs/pmc.html</a>
159      * 
160      * @return String
161      */
162     public String getChair()
163     {
164         return this.chair;
165     } //-- String getChair()
166 
167     /**
168      * Get every PMC is created by a board resolution with a
169      * specific charter. That charter should be
170      *             listed here as it gives the focus and scope of
171      * the PMC. Optional.
172      * @see <a
173      * href="http://projects.apache.org/docs/pmc.html">http://projects.apache.org/docs/pmc.html</a>
174      * 
175      * @return String
176      */
177     public String getCharter()
178     {
179         return this.charter;
180     } //-- String getCharter()
181 
182     /**
183      * Method getExtra.
184      * 
185      * @return Map
186      */
187     public java.util.Map<Object, String> getExtra()
188     {
189         if ( this.extra == null )
190         {
191             this.extra = new java.util.HashMap<Object, String>();
192         }
193 
194         return this.extra;
195     } //-- java.util.Map<Object, String> getExtra()
196 
197     /**
198      * Get the name of the PMC, including the 'Apache ', e.g.
199      * 'Apache Forrest'. Optional will be discovered from POM.<br/>
200      * <b>Default value</b>: ${project.name}
201      * @see <a
202      * href="http://projects.apache.org/docs/pmc.html">http://projects.apache.org/docs/pmc.html</a>
203      * 
204      * @return String
205      */
206     public String getName()
207     {
208         return this.name;
209     } //-- String getName()
210 
211     /**
212      * Get the top level element within a file. Optional will be
213      * discovered from POM.<br/>
214      * <b>Default value</b>: ${project.url}
215      * @see <a
216      * href="http://projects.apache.org/docs/pmc.html">http://projects.apache.org/docs/pmc.html</a>
217      * 
218      * @return String
219      */
220     public String getPmc()
221     {
222         return this.pmc;
223     } //-- String getPmc()
224 
225     /**
226      * Method getStandards.
227      * 
228      * @return List
229      */
230     public java.util.List<Standard> getStandards()
231     {
232         if ( this.standards == null )
233         {
234             this.standards = new java.util.ArrayList<Standard>();
235         }
236 
237         return this.standards;
238     } //-- java.util.List<Standard> getStandards()
239 
240     /**
241      * Get the URI of the ASFext xmlns namespace.<br/>
242      * <b>Default value</b>: http://projects.apache.org/ns/asfext#.
243      * 
244      * @return String
245      */
246     public String getXmlnsNamespaceURI()
247     {
248         return this.xmlnsNamespaceURI;
249     } //-- String getXmlnsNamespaceURI()
250 
251     /**
252      * Get the ASFext xmlns prefix.<br/>
253      * <b>Default value</b>: asfext.
254      * 
255      * @return String
256      */
257     public String getXmlnsPrefix()
258     {
259         return this.xmlnsPrefix;
260     } //-- String getXmlnsPrefix()
261 
262     /**
263      * Method hashCode.
264      * 
265      * @return int
266      */
267     public int hashCode()
268     {
269         int result = 17;
270 
271         result = 37 * result + ( included ? 0 : 1 );
272         result = 37 * result + ( pmc != null ? pmc.hashCode() : 0 );
273         result = 37 * result + ( name != null ? name.hashCode() : 0 );
274         result = 37 * result + ( charter != null ? charter.hashCode() : 0 );
275         result = 37 * result + ( chair != null ? chair.hashCode() : 0 );
276         result = 37 * result + ( extra != null ? extra.hashCode() : 0 );
277 
278         return result;
279     } //-- int hashCode()
280 
281     /**
282      * Get flag to use or not the ASF extension in the generated
283      * DOAP.
284      * 
285      * @return boolean
286      */
287     public boolean isIncluded()
288     {
289         return this.included;
290     } //-- boolean isIncluded()
291 
292     /**
293      * Method removeStandard.
294      * 
295      * @param standard
296      */
297     public void removeStandard( Standard standard )
298     {
299         getStandards().remove( standard );
300     } //-- void removeStandard( Standard )
301 
302     /**
303      * Set this should contain the name of the current PMC
304      * chairperson. Optional.<br/>
305      * <b>Note</b>: it will be discovered from
306      * ${project.developers.roles}
307      * @see <a
308      * href="http://projects.apache.org/docs/pmc.html">http://projects.apache.org/docs/pmc.html</a>
309      * 
310      * @param chair
311      */
312     public void setChair( String chair )
313     {
314         this.chair = chair;
315     } //-- void setChair( String )
316 
317     /**
318      * Set every PMC is created by a board resolution with a
319      * specific charter. That charter should be
320      *             listed here as it gives the focus and scope of
321      * the PMC. Optional.
322      * @see <a
323      * href="http://projects.apache.org/docs/pmc.html">http://projects.apache.org/docs/pmc.html</a>
324      * 
325      * @param charter
326      */
327     public void setCharter( String charter )
328     {
329         this.charter = charter;
330     } //-- void setCharter( String )
331 
332     /**
333      * Set extra ASFext vocabulary as key/value, not actually
334      * defined as plugin options.
335      * 
336      * @param extra
337      */
338     public void setExtra( java.util.Map extra )
339     {
340         this.extra = extra;
341     } //-- void setExtra( java.util.Map )
342 
343     /**
344      * Set flag to use or not the ASF extension in the generated
345      * DOAP.
346      * 
347      * @param included
348      */
349     public void setIncluded( boolean included )
350     {
351         this.included = included;
352     } //-- void setIncluded( boolean )
353 
354     /**
355      * Set the name of the PMC, including the 'Apache ', e.g.
356      * 'Apache Forrest'. Optional will be discovered from POM.<br/>
357      * <b>Default value</b>: ${project.name}
358      * @see <a
359      * href="http://projects.apache.org/docs/pmc.html">http://projects.apache.org/docs/pmc.html</a>
360      * 
361      * @param name
362      */
363     public void setName( String name )
364     {
365         this.name = name;
366     } //-- void setName( String )
367 
368     /**
369      * Set the top level element within a file. Optional will be
370      * discovered from POM.<br/>
371      * <b>Default value</b>: ${project.url}
372      * @see <a
373      * href="http://projects.apache.org/docs/pmc.html">http://projects.apache.org/docs/pmc.html</a>
374      * 
375      * @param pmc
376      */
377     public void setPmc( String pmc )
378     {
379         this.pmc = pmc;
380     } //-- void setPmc( String )
381 
382     /**
383      * Set list of Standard object. Optional.
384      * @see <a
385      * href="http://projects.apache.org/docs/standards.html">http://projects.apache.org/docs/standards.html</a>
386      * 
387      * @param standards
388      */
389     public void setStandards( java.util.List<Standard> standards )
390     {
391         this.standards = standards;
392     } //-- void setStandards( java.util.List )
393 
394     /**
395      * Set the URI of the ASFext xmlns namespace.<br/>
396      * <b>Default value</b>: http://projects.apache.org/ns/asfext#.
397      * 
398      * @param xmlnsNamespaceURI
399      */
400     public void setXmlnsNamespaceURI( String xmlnsNamespaceURI )
401     {
402         this.xmlnsNamespaceURI = xmlnsNamespaceURI;
403     } //-- void setXmlnsNamespaceURI( String )
404 
405     /**
406      * Set the ASFext xmlns prefix.<br/>
407      * <b>Default value</b>: asfext.
408      * 
409      * @param xmlnsPrefix
410      */
411     public void setXmlnsPrefix( String xmlnsPrefix )
412     {
413         this.xmlnsPrefix = xmlnsPrefix;
414     } //-- void setXmlnsPrefix( String )
415 
416     /**
417      * Method toString.
418      * 
419      * @return String
420      */
421     public java.lang.String toString()
422     {
423         StringBuilder buf = new StringBuilder( 128 );
424 
425         buf.append( "included = '" );
426         buf.append( isIncluded() );
427         buf.append( "'" );
428         buf.append( "\n" ); 
429         buf.append( "pmc = '" );
430         buf.append( getPmc() );
431         buf.append( "'" );
432         buf.append( "\n" ); 
433         buf.append( "name = '" );
434         buf.append( getName() );
435         buf.append( "'" );
436         buf.append( "\n" ); 
437         buf.append( "charter = '" );
438         buf.append( getCharter() );
439         buf.append( "'" );
440         buf.append( "\n" ); 
441         buf.append( "chair = '" );
442         buf.append( getChair() );
443         buf.append( "'" );
444         buf.append( "\n" ); 
445         buf.append( "extra = '" );
446         buf.append( getExtra() );
447         buf.append( "'" );
448 
449         return buf.toString();
450     } //-- java.lang.String toString()
451 
452 }