1 /* 2 Licensed to the Apache Software Foundation (ASF) under one 3 or more contributor license agreements. See the NOTICE file 4 distributed with this work for additional information 5 regarding copyright ownership. The ASF licenses this file 6 to you under the Apache License, Version 2.0 (the 7 "License"); you may not use this file except in compliance 8 with the License. You may obtain a copy of the License at 9 10 http://www.apache.org/licenses/LICENSE-2.0 11 12 Unless required by applicable law or agreed to in writing, 13 software distributed under the License is distributed on an 14 "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 KIND, either express or implied. See the License for the 16 specific language governing permissions and limitations 17 under the License. 18 =================== DO NOT EDIT THIS FILE ==================== 19 Generated by Modello 2.4.0, 20 any modifications will be overwritten. 21 ============================================================== 22 */ 23 24 package org.apache.maven.plugins.changes.model; 25 26 /** 27 * 28 * A single action done on the project, during this 29 * release. 30 * 31 * 32 * @version $Revision$ $Date$ 33 */ 34 @SuppressWarnings( "all" ) 35 public class Action 36 extends AbstractAction 37 implements java.io.Serializable 38 { 39 40 //--------------------------/ 41 //- Class/Member Variables -/ 42 //--------------------------/ 43 44 /** 45 * 46 * A short description of the action taken. 47 * 48 */ 49 private String action; 50 51 /** 52 * 53 * 54 * Name of developer who committed the change. 55 * <p>This can be either the id of the developer, 56 * as specified in the developers section of the pom.xml file, 57 * or the name of the developer. If you generate a changes 58 * report and specify the id of the developer, a link is 59 * created to that developer in the team.html page.</p> 60 * 61 * 62 */ 63 private String dev = ""; 64 65 /** 66 * 67 * Name of the person to be credited for this 68 * change. This can be used when a patch is submitted by a 69 * non-committer. 70 * Can be a comma separated list. 71 * 72 */ 73 private String dueTo; 74 75 /** 76 * 77 * Email of the person to be credited for this 78 * change. Can be a comma separated list. 79 * 80 */ 81 private String dueToEmail; 82 83 /** 84 * 85 * 86 * Id of the issue related to this change. This 87 * is the id in your issue tracking system. 88 * <p>The Changes plugin will generate a URL out 89 * of this id. The URL is constructed using the value of the 90 * issueLinkTemplate parameter.</p> 91 * <p>See the <a 92 * href="changes-report.html">changes-report mojo</a> for more 93 * details.</p> 94 * 95 * 96 */ 97 private String issue; 98 99 /** 100 * 101 * 102 * Supported action types are the following: 103 * <ul> 104 * <li>add: added functionality to the 105 * project.</li> 106 * <li>fix: bug fix for the project.</li> 107 * <li>update: updated some part of the 108 * project.</li> 109 * <li>remove: removed some functionality from 110 * the project.</li> 111 * </ul> 112 * 113 * 114 */ 115 private String type; 116 117 /** 118 * 119 * 120 * Id of issue tracking system. If empty 121 * 'default' value will be used. 122 * <p>The Changes plugin will generate a URL out 123 * of this id. The URL is constructed using the value of the 124 * issueLinkTemplatePerSystem parameter.</p> 125 * <p>See the <a 126 * href="changes-report.html">changes-report mojo</a> for more 127 * details.</p> 128 * 129 * 130 */ 131 private String system; 132 133 /** 134 * fix date. 135 */ 136 private String date; 137 138 /** 139 * A comma separated list of fixed issues. 140 */ 141 private String fixedIssuesString; 142 143 144 //-----------/ 145 //- Methods -/ 146 //-----------/ 147 148 /** 149 * Get a short description of the action taken. 150 * 151 * @return String 152 */ 153 public String getAction() 154 { 155 return this.action; 156 } //-- String getAction() 157 158 /** 159 * Get fix date. 160 * 161 * @return String 162 */ 163 public String getDate() 164 { 165 return this.date; 166 } //-- String getDate() 167 168 /** 169 * Get name of developer who committed the change. 170 * <p>This can be either the id of the developer, 171 * as specified in the developers section of the pom.xml file, 172 * or the name of the developer. If you generate a changes 173 * report and specify the id of the developer, a link is 174 * created to that developer in the team.html page.</p> 175 * 176 * @return String 177 */ 178 public String getDev() 179 { 180 return this.dev; 181 } //-- String getDev() 182 183 /** 184 * Get name of the person to be credited for this change. This 185 * can be used when a patch is submitted by a non-committer. 186 * Can be a comma separated list. 187 * 188 * @return String 189 */ 190 public String getDueTo() 191 { 192 return this.dueTo; 193 } //-- String getDueTo() 194 195 /** 196 * Get email of the person to be credited for this change. Can 197 * be a comma separated list. 198 * 199 * @return String 200 */ 201 public String getDueToEmail() 202 { 203 return this.dueToEmail; 204 } //-- String getDueToEmail() 205 206 /** 207 * Get a comma separated list of fixed issues. 208 * 209 * @return String 210 */ 211 public String getFixedIssuesString() 212 { 213 return this.fixedIssuesString; 214 } //-- String getFixedIssuesString() 215 216 /** 217 * Get id of the issue related to this change. This is the id 218 * in your issue tracking system. 219 * <p>The Changes plugin will generate a URL out 220 * of this id. The URL is constructed using the value of the 221 * issueLinkTemplate parameter.</p> 222 * <p>See the <a 223 * href="changes-report.html">changes-report mojo</a> for more 224 * details.</p> 225 * 226 * @return String 227 */ 228 public String getIssue() 229 { 230 return this.issue; 231 } //-- String getIssue() 232 233 /** 234 * Get id of issue tracking system. If empty 'default' value 235 * will be used. 236 * <p>The Changes plugin will generate a URL out 237 * of this id. The URL is constructed using the value of the 238 * issueLinkTemplatePerSystem parameter.</p> 239 * <p>See the <a 240 * href="changes-report.html">changes-report mojo</a> for more 241 * details.</p> 242 * 243 * @return String 244 */ 245 public String getSystem() 246 { 247 return this.system; 248 } //-- String getSystem() 249 250 /** 251 * Get supported action types are the following: 252 * <ul> 253 * <li>add: added functionality to the 254 * project.</li> 255 * <li>fix: bug fix for the project.</li> 256 * <li>update: updated some part of the 257 * project.</li> 258 * <li>remove: removed some functionality from 259 * the project.</li> 260 * </ul> 261 * 262 * @return String 263 */ 264 public String getType() 265 { 266 return this.type; 267 } //-- String getType() 268 269 /** 270 * Set a short description of the action taken. 271 * 272 * @param action a action object. 273 */ 274 public void setAction( String action ) 275 { 276 this.action = action; 277 } //-- void setAction( String ) 278 279 /** 280 * Set fix date. 281 * 282 * @param date a date object. 283 */ 284 public void setDate( String date ) 285 { 286 this.date = date; 287 } //-- void setDate( String ) 288 289 /** 290 * Set name of developer who committed the change. 291 * <p>This can be either the id of the developer, 292 * as specified in the developers section of the pom.xml file, 293 * or the name of the developer. If you generate a changes 294 * report and specify the id of the developer, a link is 295 * created to that developer in the team.html page.</p> 296 * 297 * @param dev a dev object. 298 */ 299 public void setDev( String dev ) 300 { 301 this.dev = dev; 302 } //-- void setDev( String ) 303 304 /** 305 * Set name of the person to be credited for this change. This 306 * can be used when a patch is submitted by a non-committer. 307 * Can be a comma separated list. 308 * 309 * @param dueTo a dueTo object. 310 */ 311 public void setDueTo( String dueTo ) 312 { 313 this.dueTo = dueTo; 314 } //-- void setDueTo( String ) 315 316 /** 317 * Set email of the person to be credited for this change. Can 318 * be a comma separated list. 319 * 320 * @param dueToEmail a dueToEmail object. 321 */ 322 public void setDueToEmail( String dueToEmail ) 323 { 324 this.dueToEmail = dueToEmail; 325 } //-- void setDueToEmail( String ) 326 327 /** 328 * Set a comma separated list of fixed issues. 329 * 330 * @param fixedIssuesString a fixedIssuesString object. 331 */ 332 public void setFixedIssuesString( String fixedIssuesString ) 333 { 334 this.fixedIssuesString = fixedIssuesString; 335 } //-- void setFixedIssuesString( String ) 336 337 /** 338 * Set id of the issue related to this change. This is the id 339 * in your issue tracking system. 340 * <p>The Changes plugin will generate a URL out 341 * of this id. The URL is constructed using the value of the 342 * issueLinkTemplate parameter.</p> 343 * <p>See the <a 344 * href="changes-report.html">changes-report mojo</a> for more 345 * details.</p> 346 * 347 * @param issue a issue object. 348 */ 349 public void setIssue( String issue ) 350 { 351 this.issue = issue; 352 } //-- void setIssue( String ) 353 354 /** 355 * Set id of issue tracking system. If empty 'default' value 356 * will be used. 357 * <p>The Changes plugin will generate a URL out 358 * of this id. The URL is constructed using the value of the 359 * issueLinkTemplatePerSystem parameter.</p> 360 * <p>See the <a 361 * href="changes-report.html">changes-report mojo</a> for more 362 * details.</p> 363 * 364 * @param system a system object. 365 */ 366 public void setSystem( String system ) 367 { 368 this.system = system; 369 } //-- void setSystem( String ) 370 371 /** 372 * Set supported action types are the following: 373 * <ul> 374 * <li>add: added functionality to the 375 * project.</li> 376 * <li>fix: bug fix for the project.</li> 377 * <li>update: updated some part of the 378 * project.</li> 379 * <li>remove: removed some functionality from 380 * the project.</li> 381 * </ul> 382 * 383 * @param type a type object. 384 */ 385 public void setType( String type ) 386 { 387 this.type = type; 388 } //-- void setType( String ) 389 390 }