Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
Action |
|
| 1.4166666666666667;1,417 |
1 | /* | |
2 | =================== DO NOT EDIT THIS FILE ==================== | |
3 | Generated by Modello 1.0.1 on 2009-12-03 19:52:14, | |
4 | any modifications will be overwritten. | |
5 | ============================================================== | |
6 | */ | |
7 | ||
8 | package org.apache.maven.plugins.changes.model; | |
9 | ||
10 | /** | |
11 | * | |
12 | * A single action done on the project, during this | |
13 | * release. | |
14 | * | |
15 | * | |
16 | * @version $Revision$ $Date$ | |
17 | */ | |
18 | 17 | public class Action |
19 | implements java.io.Serializable | |
20 | { | |
21 | ||
22 | //--------------------------/ | |
23 | //- Class/Member Variables -/ | |
24 | //--------------------------/ | |
25 | ||
26 | /** | |
27 | * | |
28 | * A short description of the action taken. | |
29 | * | |
30 | */ | |
31 | private String action; | |
32 | ||
33 | /** | |
34 | * | |
35 | * | |
36 | * <p>Name of developer who committed the | |
37 | * change.</p> | |
38 | * <p>This <b>MUST</b> be the name of the developer | |
39 | * as described in the developers section of the pom.xml | |
40 | * file.</p> | |
41 | * | |
42 | * | |
43 | */ | |
44 | private String dev; | |
45 | ||
46 | /** | |
47 | * | |
48 | * Name of the person to be credited for this | |
49 | * change. This can be used when a patch is submitted by a | |
50 | * non-committer. | |
51 | * | |
52 | */ | |
53 | private String dueTo; | |
54 | ||
55 | /** | |
56 | * | |
57 | * Email of the person to be credited for this | |
58 | * change. | |
59 | * | |
60 | */ | |
61 | private String dueToEmail; | |
62 | ||
63 | /** | |
64 | * | |
65 | * | |
66 | * <p>Id of the issue related to this change. | |
67 | * This is the id in your issue tracking system.</p> | |
68 | * <p>The Changes plugin will generate a URL out | |
69 | * of this id. The URL is constructed using the value of the | |
70 | * issueLinkTemplate parameter.</p> | |
71 | * <p>See the <a | |
72 | * href="changes-report.html">changes-report mojo</a> for more | |
73 | * details.</p> | |
74 | * | |
75 | * | |
76 | */ | |
77 | private String issue; | |
78 | ||
79 | /** | |
80 | * | |
81 | * | |
82 | * Supported action types are the following: | |
83 | * <ul> | |
84 | * <li>add : added functionnality to the | |
85 | * project.</li> | |
86 | * <li>fix : bug fix for the project.</li> | |
87 | * <li>update : updated some part of the | |
88 | * project.</li> | |
89 | * <li>remove : removed some functionnality from | |
90 | * the project.</li> | |
91 | * </ul> | |
92 | * | |
93 | * | |
94 | */ | |
95 | private String type; | |
96 | ||
97 | /** | |
98 | * | |
99 | * | |
100 | * <p>Id of issue tracking system. If empty | |
101 | * 'default' value will be use.</p> | |
102 | * <p>The Changes plugin will generate a URL out | |
103 | * of this id. The URL is constructed using the value of the | |
104 | * issueLinkTemplatePerSystem parameter.</p> | |
105 | * <p>See the <a | |
106 | * href="changes-report.html">changes-report mojo</a> for more | |
107 | * details.</p> | |
108 | * | |
109 | * | |
110 | */ | |
111 | private String system; | |
112 | ||
113 | /** | |
114 | * fix date. | |
115 | */ | |
116 | private String date; | |
117 | ||
118 | /** | |
119 | * Field fixedIssues. | |
120 | */ | |
121 | private java.util.List/*<FixedIssue>*/ fixedIssues; | |
122 | ||
123 | /** | |
124 | * Field dueTos. | |
125 | */ | |
126 | private java.util.List/*<DueTo>*/ dueTos; | |
127 | ||
128 | ||
129 | //-----------/ | |
130 | //- Methods -/ | |
131 | //-----------/ | |
132 | ||
133 | /** | |
134 | * Method addDueTo. | |
135 | * | |
136 | * @param dueTo | |
137 | */ | |
138 | public void addDueTo( DueTo dueTo ) | |
139 | { | |
140 | 0 | if ( !(dueTo instanceof DueTo) ) |
141 | { | |
142 | 0 | throw new ClassCastException( "Action.addDueTos(dueTo) parameter must be instanceof " + DueTo.class.getName() ); |
143 | } | |
144 | 0 | getDueTos().add( dueTo ); |
145 | 0 | } //-- void addDueTo( DueTo ) |
146 | ||
147 | /** | |
148 | * Method addFixedIssue. | |
149 | * | |
150 | * @param fixedIssue | |
151 | */ | |
152 | public void addFixedIssue( FixedIssue fixedIssue ) | |
153 | { | |
154 | 0 | if ( !(fixedIssue instanceof FixedIssue) ) |
155 | { | |
156 | 0 | throw new ClassCastException( "Action.addFixedIssues(fixedIssue) parameter must be instanceof " + FixedIssue.class.getName() ); |
157 | } | |
158 | 0 | getFixedIssues().add( fixedIssue ); |
159 | 0 | } //-- void addFixedIssue( FixedIssue ) |
160 | ||
161 | /** | |
162 | * Get a short description of the action taken. | |
163 | * | |
164 | * @return String | |
165 | */ | |
166 | public String getAction() | |
167 | { | |
168 | 6 | return this.action; |
169 | } //-- String getAction() | |
170 | ||
171 | /** | |
172 | * Get fix date. | |
173 | * | |
174 | * @return String | |
175 | */ | |
176 | public String getDate() | |
177 | { | |
178 | 0 | return this.date; |
179 | } //-- String getDate() | |
180 | ||
181 | /** | |
182 | * Get <p>Name of developer who committed the change.</p> | |
183 | * <p>This <b>MUST</b> be the name of the developer | |
184 | * as described in the developers section of the pom.xml | |
185 | * file.</p> | |
186 | * | |
187 | * @return String | |
188 | */ | |
189 | public String getDev() | |
190 | { | |
191 | 1 | return this.dev; |
192 | } //-- String getDev() | |
193 | ||
194 | /** | |
195 | * Get name of the person to be credited for this change. This | |
196 | * can be used when a patch is submitted by a non-committer. | |
197 | * | |
198 | * @return String | |
199 | */ | |
200 | public String getDueTo() | |
201 | { | |
202 | 6 | return this.dueTo; |
203 | } //-- String getDueTo() | |
204 | ||
205 | /** | |
206 | * Get email of the person to be credited for this change. | |
207 | * | |
208 | * @return String | |
209 | */ | |
210 | public String getDueToEmail() | |
211 | { | |
212 | 1 | return this.dueToEmail; |
213 | } //-- String getDueToEmail() | |
214 | ||
215 | /** | |
216 | * Method getDueTos. | |
217 | * | |
218 | * @return List | |
219 | */ | |
220 | public java.util.List/*<DueTo>*/ getDueTos() | |
221 | { | |
222 | 10 | if ( this.dueTos == null ) |
223 | { | |
224 | 5 | this.dueTos = new java.util.ArrayList/*<DueTo>*/(); |
225 | } | |
226 | ||
227 | 10 | return this.dueTos; |
228 | } //-- java.util.List/*<DueTo>*/ getDueTos() | |
229 | ||
230 | /** | |
231 | * Method getFixedIssues. | |
232 | * | |
233 | * @return List | |
234 | */ | |
235 | public java.util.List/*<FixedIssue>*/ getFixedIssues() | |
236 | { | |
237 | 10 | if ( this.fixedIssues == null ) |
238 | { | |
239 | 4 | this.fixedIssues = new java.util.ArrayList/*<FixedIssue>*/(); |
240 | } | |
241 | ||
242 | 10 | return this.fixedIssues; |
243 | } //-- java.util.List/*<FixedIssue>*/ getFixedIssues() | |
244 | ||
245 | /** | |
246 | * Get <p>Id of the issue related to this change. This is the | |
247 | * id in your issue tracking system.</p> | |
248 | * <p>The Changes plugin will generate a URL out | |
249 | * of this id. The URL is constructed using the value of the | |
250 | * issueLinkTemplate parameter.</p> | |
251 | * <p>See the <a | |
252 | * href="changes-report.html">changes-report mojo</a> for more | |
253 | * details.</p> | |
254 | * | |
255 | * @return String | |
256 | */ | |
257 | public String getIssue() | |
258 | { | |
259 | 7 | return this.issue; |
260 | } //-- String getIssue() | |
261 | ||
262 | /** | |
263 | * Get <p>Id of issue tracking system. If empty 'default' value | |
264 | * will be use.</p> | |
265 | * <p>The Changes plugin will generate a URL out | |
266 | * of this id. The URL is constructed using the value of the | |
267 | * issueLinkTemplatePerSystem parameter.</p> | |
268 | * <p>See the <a | |
269 | * href="changes-report.html">changes-report mojo</a> for more | |
270 | * details.</p> | |
271 | * | |
272 | * @return String | |
273 | */ | |
274 | public String getSystem() | |
275 | { | |
276 | 0 | return this.system; |
277 | } //-- String getSystem() | |
278 | ||
279 | /** | |
280 | * Get supported action types are the following: | |
281 | * <ul> | |
282 | * <li>add : added functionnality to the | |
283 | * project.</li> | |
284 | * <li>fix : bug fix for the project.</li> | |
285 | * <li>update : updated some part of the | |
286 | * project.</li> | |
287 | * <li>remove : removed some functionnality from | |
288 | * the project.</li> | |
289 | * </ul> | |
290 | * | |
291 | * @return String | |
292 | */ | |
293 | public String getType() | |
294 | { | |
295 | 81 | return this.type; |
296 | } //-- String getType() | |
297 | ||
298 | /** | |
299 | * Method removeDueTo. | |
300 | * | |
301 | * @param dueTo | |
302 | */ | |
303 | public void removeDueTo( DueTo dueTo ) | |
304 | { | |
305 | 0 | if ( !(dueTo instanceof DueTo) ) |
306 | { | |
307 | 0 | throw new ClassCastException( "Action.removeDueTos(dueTo) parameter must be instanceof " + DueTo.class.getName() ); |
308 | } | |
309 | 0 | getDueTos().remove( dueTo ); |
310 | 0 | } //-- void removeDueTo( DueTo ) |
311 | ||
312 | /** | |
313 | * Method removeFixedIssue. | |
314 | * | |
315 | * @param fixedIssue | |
316 | */ | |
317 | public void removeFixedIssue( FixedIssue fixedIssue ) | |
318 | { | |
319 | 0 | if ( !(fixedIssue instanceof FixedIssue) ) |
320 | { | |
321 | 0 | throw new ClassCastException( "Action.removeFixedIssues(fixedIssue) parameter must be instanceof " + FixedIssue.class.getName() ); |
322 | } | |
323 | 0 | getFixedIssues().remove( fixedIssue ); |
324 | 0 | } //-- void removeFixedIssue( FixedIssue ) |
325 | ||
326 | /** | |
327 | * Set a short description of the action taken. | |
328 | * | |
329 | * @param action | |
330 | */ | |
331 | public void setAction( String action ) | |
332 | { | |
333 | 12 | this.action = action; |
334 | 12 | } //-- void setAction( String ) |
335 | ||
336 | /** | |
337 | * Set fix date. | |
338 | * | |
339 | * @param date | |
340 | */ | |
341 | public void setDate( String date ) | |
342 | { | |
343 | 1 | this.date = date; |
344 | 1 | } //-- void setDate( String ) |
345 | ||
346 | /** | |
347 | * Set <p>Name of developer who committed the change.</p> | |
348 | * <p>This <b>MUST</b> be the name of the developer | |
349 | * as described in the developers section of the pom.xml | |
350 | * file.</p> | |
351 | * | |
352 | * @param dev | |
353 | */ | |
354 | public void setDev( String dev ) | |
355 | { | |
356 | 12 | this.dev = dev; |
357 | 12 | } //-- void setDev( String ) |
358 | ||
359 | /** | |
360 | * Set name of the person to be credited for this change. This | |
361 | * can be used when a patch is submitted by a non-committer. | |
362 | * | |
363 | * @param dueTo | |
364 | */ | |
365 | public void setDueTo( String dueTo ) | |
366 | { | |
367 | 3 | this.dueTo = dueTo; |
368 | 3 | } //-- void setDueTo( String ) |
369 | ||
370 | /** | |
371 | * Set email of the person to be credited for this change. | |
372 | * | |
373 | * @param dueToEmail | |
374 | */ | |
375 | public void setDueToEmail( String dueToEmail ) | |
376 | { | |
377 | 3 | this.dueToEmail = dueToEmail; |
378 | 3 | } //-- void setDueToEmail( String ) |
379 | ||
380 | /** | |
381 | * Set a list of contibutors for this issue. | |
382 | * | |
383 | * @param dueTos | |
384 | */ | |
385 | public void setDueTos( java.util.List/*<DueTo>*/ dueTos ) | |
386 | { | |
387 | 0 | this.dueTos = dueTos; |
388 | 0 | } //-- void setDueTos( java.util.List ) |
389 | ||
390 | /** | |
391 | * Set a list of fix issues. | |
392 | * | |
393 | * @param fixedIssues | |
394 | */ | |
395 | public void setFixedIssues( java.util.List/*<FixedIssue>*/ fixedIssues ) | |
396 | { | |
397 | 0 | this.fixedIssues = fixedIssues; |
398 | 0 | } //-- void setFixedIssues( java.util.List ) |
399 | ||
400 | /** | |
401 | * Set <p>Id of the issue related to this change. This is the | |
402 | * id in your issue tracking system.</p> | |
403 | * <p>The Changes plugin will generate a URL out | |
404 | * of this id. The URL is constructed using the value of the | |
405 | * issueLinkTemplate parameter.</p> | |
406 | * <p>See the <a | |
407 | * href="changes-report.html">changes-report mojo</a> for more | |
408 | * details.</p> | |
409 | * | |
410 | * @param issue | |
411 | */ | |
412 | public void setIssue( String issue ) | |
413 | { | |
414 | 5 | this.issue = issue; |
415 | 5 | } //-- void setIssue( String ) |
416 | ||
417 | /** | |
418 | * Set <p>Id of issue tracking system. If empty 'default' value | |
419 | * will be use.</p> | |
420 | * <p>The Changes plugin will generate a URL out | |
421 | * of this id. The URL is constructed using the value of the | |
422 | * issueLinkTemplatePerSystem parameter.</p> | |
423 | * <p>See the <a | |
424 | * href="changes-report.html">changes-report mojo</a> for more | |
425 | * details.</p> | |
426 | * | |
427 | * @param system | |
428 | */ | |
429 | public void setSystem( String system ) | |
430 | { | |
431 | 2 | this.system = system; |
432 | 2 | } //-- void setSystem( String ) |
433 | ||
434 | /** | |
435 | * Set supported action types are the following: | |
436 | * <ul> | |
437 | * <li>add : added functionnality to the | |
438 | * project.</li> | |
439 | * <li>fix : bug fix for the project.</li> | |
440 | * <li>update : updated some part of the | |
441 | * project.</li> | |
442 | * <li>remove : removed some functionnality from | |
443 | * the project.</li> | |
444 | * </ul> | |
445 | * | |
446 | * @param type | |
447 | */ | |
448 | public void setType( String type ) | |
449 | { | |
450 | 12 | this.type = type; |
451 | 12 | } //-- void setType( String ) |
452 | ||
453 | ||
454 | } |