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