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   * Description of a person who has contributed to the project, but
12   * who does not have
13   *         commit privileges. Usually, these contributions come in
14   * the form of patches submitted.
15   * 
16   * @version $Revision$ $Date$
17   */
18  public class Contributor
19      implements java.io.Serializable
20  {
21  
22        //--------------------------/
23       //- Class/Member Variables -/
24      //--------------------------/
25  
26      /**
27       * The full name of the contributor.
28       */
29      private String name;
30  
31      /**
32       * The email address of the contributor.
33       */
34      private String email;
35  
36      /**
37       * The URL for the homepage of the contributor.
38       */
39      private String url;
40  
41      /**
42       * The organization to which the contributor belongs.
43       */
44      private String organization;
45  
46      /**
47       * The URL of the organization.
48       */
49      private String organizationUrl;
50  
51      /**
52       * Field roles.
53       */
54      private java.util.List<String> roles;
55  
56      /**
57       * The timezone the contributor is in. This is a number in the
58       * range -11 to 12.
59       */
60      private String timezone;
61  
62      /**
63       * Field properties.
64       */
65      private java.util.Properties properties;
66  
67  
68        //-----------/
69       //- Methods -/
70      //-----------/
71  
72      /**
73       * Method addProperty.
74       * 
75       * @param key
76       * @param value
77       */
78      public void addProperty( String key, String value )
79      {
80          getProperties().put( key, value );
81      } //-- void addProperty( String, String )
82  
83      /**
84       * Method addRole.
85       * 
86       * @param string
87       */
88      public void addRole( String string )
89      {
90          if ( !(string instanceof String) )
91          {
92              throw new ClassCastException( "Contributor.addRoles(string) parameter must be instanceof " + String.class.getName() );
93          }
94          getRoles().add( string );
95      } //-- void addRole( String )
96  
97      /**
98       * Get the email address of the contributor.
99       * 
100      * @return String
101      */
102     public String getEmail()
103     {
104         return this.email;
105     } //-- String getEmail()
106 
107     /**
108      * Get the full name of the contributor.
109      * 
110      * @return String
111      */
112     public String getName()
113     {
114         return this.name;
115     } //-- String getName()
116 
117     /**
118      * Get the organization to which the contributor belongs.
119      * 
120      * @return String
121      */
122     public String getOrganization()
123     {
124         return this.organization;
125     } //-- String getOrganization()
126 
127     /**
128      * Get the URL of the organization.
129      * 
130      * @return String
131      */
132     public String getOrganizationUrl()
133     {
134         return this.organizationUrl;
135     } //-- String getOrganizationUrl()
136 
137     /**
138      * Method getProperties.
139      * 
140      * @return Properties
141      */
142     public java.util.Properties getProperties()
143     {
144         if ( this.properties == null )
145         {
146             this.properties = new java.util.Properties();
147         }
148 
149         return this.properties;
150     } //-- java.util.Properties getProperties()
151 
152     /**
153      * Method getRoles.
154      * 
155      * @return List
156      */
157     public java.util.List<String> getRoles()
158     {
159         if ( this.roles == null )
160         {
161             this.roles = new java.util.ArrayList<String>();
162         }
163 
164         return this.roles;
165     } //-- java.util.List<String> getRoles()
166 
167     /**
168      * Get the timezone the contributor is in. This is a number in
169      * the range -11 to 12.
170      * 
171      * @return String
172      */
173     public String getTimezone()
174     {
175         return this.timezone;
176     } //-- String getTimezone()
177 
178     /**
179      * Get the URL for the homepage of the contributor.
180      * 
181      * @return String
182      */
183     public String getUrl()
184     {
185         return this.url;
186     } //-- String getUrl()
187 
188     /**
189      * Method removeRole.
190      * 
191      * @param string
192      */
193     public void removeRole( String string )
194     {
195         if ( !(string instanceof String) )
196         {
197             throw new ClassCastException( "Contributor.removeRoles(string) parameter must be instanceof " + String.class.getName() );
198         }
199         getRoles().remove( string );
200     } //-- void removeRole( String )
201 
202     /**
203      * Set the email address of the contributor.
204      * 
205      * @param email
206      */
207     public void setEmail( String email )
208     {
209         this.email = email;
210     } //-- void setEmail( String )
211 
212     /**
213      * Set the full name of the contributor.
214      * 
215      * @param name
216      */
217     public void setName( String name )
218     {
219         this.name = name;
220     } //-- void setName( String )
221 
222     /**
223      * Set the organization to which the contributor belongs.
224      * 
225      * @param organization
226      */
227     public void setOrganization( String organization )
228     {
229         this.organization = organization;
230     } //-- void setOrganization( String )
231 
232     /**
233      * Set the URL of the organization.
234      * 
235      * @param organizationUrl
236      */
237     public void setOrganizationUrl( String organizationUrl )
238     {
239         this.organizationUrl = organizationUrl;
240     } //-- void setOrganizationUrl( String )
241 
242     /**
243      * Set properties about the contributor, such as an instant
244      * messenger handle.
245      * 
246      * @param properties
247      */
248     public void setProperties( java.util.Properties properties )
249     {
250         this.properties = properties;
251     } //-- void setProperties( java.util.Properties )
252 
253     /**
254      * Set the roles the contributor plays in the project. Each
255      * role is described by a
256      *             <code>role</code> element, the body of which is
257      * a role name. This can also be used to
258      *             describe the contribution.
259      * 
260      * @param roles
261      */
262     public void setRoles( java.util.List<String> roles )
263     {
264         this.roles = roles;
265     } //-- void setRoles( java.util.List )
266 
267     /**
268      * Set the timezone the contributor is in. This is a number in
269      * the range -11 to 12.
270      * 
271      * @param timezone
272      */
273     public void setTimezone( String timezone )
274     {
275         this.timezone = timezone;
276     } //-- void setTimezone( String )
277 
278     /**
279      * Set the URL for the homepage of the contributor.
280      * 
281      * @param url
282      */
283     public void setUrl( String url )
284     {
285         this.url = url;
286     } //-- void setUrl( String )
287 
288 
289 }