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