1 /* 2 =================== DO NOT EDIT THIS FILE ==================== 3 Generated by Modello 1.4.1 on 2011-11-29 12:00:52, 4 any modifications will be overwritten. 5 ============================================================== 6 */ 7 8 package org.apache.maven.plugin.assembly.model; 9 10 /** 11 * 12 * Contains configuration options for including the binary 13 * files of a 14 * project module in an assembly. 15 * 16 * 17 * @version $Revision$ $Date$ 18 */ 19 @SuppressWarnings( "all" ) 20 public class ModuleBinaries 21 implements java.io.Serializable 22 { 23 24 //--------------------------/ 25 //- Class/Member Variables -/ 26 //--------------------------/ 27 28 /** 29 * 30 * Sets the output directory relative to the root 31 * of the root directory of the assembly. For 32 * example, 33 * "log" will put the specified files in the log 34 * directory, 35 * directly beneath the root of the archive. 36 * 37 */ 38 private String outputDirectory; 39 40 /** 41 * Field includes. 42 */ 43 private java.util.List<String> includes; 44 45 /** 46 * Field excludes. 47 */ 48 private java.util.List<String> excludes; 49 50 /** 51 * 52 * 53 * Similar to a UNIX permission, sets the file mode 54 * of the files included. 55 * THIS IS AN OCTAL VALUE. 56 * Format: (User)(Group)(Other) where each 57 * component is a sum of Read = 4, 58 * Write = 2, and Execute = 1. For example, the 59 * value 0644 60 * translates to User read-write, Group and Other 61 * read-only. 62 * <a 63 * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more 64 * on unix-style permissions)</a> 65 * 66 * 67 */ 68 private String fileMode; 69 70 /** 71 * 72 * 73 * Similar to a UNIX permission, sets the directory 74 * mode of the directories 75 * included. 76 * THIS IS AN OCTAL VALUE. 77 * Format: (User)(Group)(Other) where each 78 * component is a sum of 79 * Read = 4, Write = 2, and Execute = 1. For 80 * example, the value 81 * 0755 translates to User read-write, Group and 82 * Other read-only. 83 * <a 84 * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more 85 * on unix-style permissions)</a> 86 * 87 * 88 */ 89 private String directoryMode; 90 91 /** 92 * 93 * When specified, the attachmentClassifier will 94 * cause the assembler to look at artifacts 95 * attached to the module instead of the main project 96 * artifact. If it can find an attached 97 * artifact matching the specified classifier, it 98 * will use it; otherwise, it will throw an 99 * exception. (Since 2.2) 100 * . 101 */ 102 private String attachmentClassifier; 103 104 /** 105 * 106 * If set to true, the plugin will include the direct 107 * and transitive dependencies of 108 * of the project modules included here. Otherwise, 109 * it will only include the module 110 * packages only. Default value is true. 111 * 112 */ 113 private boolean includeDependencies = true; 114 115 /** 116 * Field dependencySets. 117 */ 118 private java.util.List<DependencySet> dependencySets; 119 120 /** 121 * 122 * If set to true, this property will unpack all 123 * module packages 124 * into the specified output directory. When set to 125 * false 126 * module packages will be included as archives 127 * (jars). 128 * Default value is true. 129 * 130 */ 131 private boolean unpack = true; 132 133 /** 134 * 135 * Allows the specification of includes and excludes, 136 * along with filtering options, for items 137 * unpacked from a module artifact. (Since 2.2) 138 * . 139 */ 140 private UnpackOptions unpackOptions; 141 142 /** 143 * 144 * Sets the mapping pattern for all NON-UNPACKED 145 * dependencies included 146 * in this assembly. 147 * Default is 148 * ${module.artifactId}-${module.version}${dashClassifier?}.${module.extension}. 149 * (Since 2.2-beta-2; 2.2-beta-1 uses 150 * ${artifactId}-${version}${dashClassifier?}.${extension}) 151 * NOTE: If the 152 * dependencySet specifies unpack == true, 153 * outputFileNameMapping WILL NOT BE USED; in these cases, use 154 * outputDirectory. 155 * 156 */ 157 private String outputFileNameMapping = "${module.artifactId}-${module.version}${dashClassifier?}.${module.extension}"; 158 159 160 //-----------/ 161 //- Methods -/ 162 //-----------/ 163 164 /** 165 * Method addDependencySet. 166 * 167 * @param dependencySet 168 */ 169 public void addDependencySet( DependencySet dependencySet ) 170 { 171 getDependencySets().add( dependencySet ); 172 } //-- void addDependencySet( DependencySet ) 173 174 /** 175 * Method addExclude. 176 * 177 * @param string 178 */ 179 public void addExclude( String string ) 180 { 181 getExcludes().add( string ); 182 } //-- void addExclude( String ) 183 184 /** 185 * Method addInclude. 186 * 187 * @param string 188 */ 189 public void addInclude( String string ) 190 { 191 getIncludes().add( string ); 192 } //-- void addInclude( String ) 193 194 /** 195 * Get when specified, the attachmentClassifier will cause the 196 * assembler to look at artifacts 197 * attached to the module instead of the main project 198 * artifact. If it can find an attached 199 * artifact matching the specified classifier, it 200 * will use it; otherwise, it will throw an 201 * exception. (Since 2.2). 202 * 203 * @return String 204 */ 205 public String getAttachmentClassifier() 206 { 207 return this.attachmentClassifier; 208 } //-- String getAttachmentClassifier() 209 210 /** 211 * Method getDependencySets. 212 * 213 * @return List 214 */ 215 public java.util.List<DependencySet> getDependencySets() 216 { 217 if ( this.dependencySets == null ) 218 { 219 this.dependencySets = new java.util.ArrayList<DependencySet>(); 220 } 221 222 return this.dependencySets; 223 } //-- java.util.List<DependencySet> getDependencySets() 224 225 /** 226 * Get similar to a UNIX permission, sets the directory mode of 227 * the directories 228 * included. 229 * THIS IS AN OCTAL VALUE. 230 * Format: (User)(Group)(Other) where each 231 * component is a sum of 232 * Read = 4, Write = 2, and Execute = 1. For 233 * example, the value 234 * 0755 translates to User read-write, Group and 235 * Other read-only. 236 * <a 237 * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more 238 * on unix-style permissions)</a> 239 * 240 * @return String 241 */ 242 public String getDirectoryMode() 243 { 244 return this.directoryMode; 245 } //-- String getDirectoryMode() 246 247 /** 248 * Method getExcludes. 249 * 250 * @return List 251 */ 252 public java.util.List<String> getExcludes() 253 { 254 if ( this.excludes == null ) 255 { 256 this.excludes = new java.util.ArrayList<String>(); 257 } 258 259 return this.excludes; 260 } //-- java.util.List<String> getExcludes() 261 262 /** 263 * Get similar to a UNIX permission, sets the file mode of the 264 * files included. 265 * THIS IS AN OCTAL VALUE. 266 * Format: (User)(Group)(Other) where each 267 * component is a sum of Read = 4, 268 * Write = 2, and Execute = 1. For example, the 269 * value 0644 270 * translates to User read-write, Group and Other 271 * read-only. 272 * <a 273 * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more 274 * on unix-style permissions)</a> 275 * 276 * @return String 277 */ 278 public String getFileMode() 279 { 280 return this.fileMode; 281 } //-- String getFileMode() 282 283 /** 284 * Method getIncludes. 285 * 286 * @return List 287 */ 288 public java.util.List<String> getIncludes() 289 { 290 if ( this.includes == null ) 291 { 292 this.includes = new java.util.ArrayList<String>(); 293 } 294 295 return this.includes; 296 } //-- java.util.List<String> getIncludes() 297 298 /** 299 * Get sets the output directory relative to the root 300 * of the root directory of the assembly. For 301 * example, 302 * "log" will put the specified files in the log 303 * directory, 304 * directly beneath the root of the archive. 305 * 306 * @return String 307 */ 308 public String getOutputDirectory() 309 { 310 return this.outputDirectory; 311 } //-- String getOutputDirectory() 312 313 /** 314 * Get sets the mapping pattern for all NON-UNPACKED 315 * dependencies included 316 * in this assembly. 317 * Default is 318 * ${module.artifactId}-${module.version}${dashClassifier?}.${module.extension}. 319 * (Since 2.2-beta-2; 2.2-beta-1 uses 320 * ${artifactId}-${version}${dashClassifier?}.${extension}) 321 * NOTE: If the 322 * dependencySet specifies unpack == true, 323 * outputFileNameMapping WILL NOT BE USED; in these cases, use 324 * outputDirectory. 325 * 326 * @return String 327 */ 328 public String getOutputFileNameMapping() 329 { 330 return this.outputFileNameMapping; 331 } //-- String getOutputFileNameMapping() 332 333 /** 334 * Get allows the specification of includes and excludes, along 335 * with filtering options, for items 336 * unpacked from a module artifact. (Since 2.2). 337 * 338 * @return UnpackOptions 339 */ 340 public UnpackOptions getUnpackOptions() 341 { 342 return this.unpackOptions; 343 } //-- UnpackOptions getUnpackOptions() 344 345 /** 346 * Get if set to true, the plugin will include the direct and 347 * transitive dependencies of 348 * of the project modules included here. Otherwise, 349 * it will only include the module 350 * packages only. Default value is true. 351 * 352 * @return boolean 353 */ 354 public boolean isIncludeDependencies() 355 { 356 return this.includeDependencies; 357 } //-- boolean isIncludeDependencies() 358 359 /** 360 * Get if set to true, this property will unpack all module 361 * packages 362 * into the specified output directory. When set to 363 * false 364 * module packages will be included as archives 365 * (jars). 366 * Default value is true. 367 * 368 * @return boolean 369 */ 370 public boolean isUnpack() 371 { 372 return this.unpack; 373 } //-- boolean isUnpack() 374 375 /** 376 * Method removeDependencySet. 377 * 378 * @param dependencySet 379 */ 380 public void removeDependencySet( DependencySet dependencySet ) 381 { 382 getDependencySets().remove( dependencySet ); 383 } //-- void removeDependencySet( DependencySet ) 384 385 /** 386 * Method removeExclude. 387 * 388 * @param string 389 */ 390 public void removeExclude( String string ) 391 { 392 getExcludes().remove( string ); 393 } //-- void removeExclude( String ) 394 395 /** 396 * Method removeInclude. 397 * 398 * @param string 399 */ 400 public void removeInclude( String string ) 401 { 402 getIncludes().remove( string ); 403 } //-- void removeInclude( String ) 404 405 /** 406 * Set when specified, the attachmentClassifier will cause the 407 * assembler to look at artifacts 408 * attached to the module instead of the main project 409 * artifact. If it can find an attached 410 * artifact matching the specified classifier, it 411 * will use it; otherwise, it will throw an 412 * exception. (Since 2.2). 413 * 414 * @param attachmentClassifier 415 */ 416 public void setAttachmentClassifier( String attachmentClassifier ) 417 { 418 this.attachmentClassifier = attachmentClassifier; 419 } //-- void setAttachmentClassifier( String ) 420 421 /** 422 * Set specifies which dependencies of the module to include in 423 * the assembly. A 424 * dependencySet is specified by providing one or 425 * more of 426 * <dependencySet> subelements. (Since 2.2). 427 * 428 * @param dependencySets 429 */ 430 public void setDependencySets( java.util.List<DependencySet> dependencySets ) 431 { 432 this.dependencySets = dependencySets; 433 } //-- void setDependencySets( java.util.List ) 434 435 /** 436 * Set similar to a UNIX permission, sets the directory mode of 437 * the directories 438 * included. 439 * THIS IS AN OCTAL VALUE. 440 * Format: (User)(Group)(Other) where each 441 * component is a sum of 442 * Read = 4, Write = 2, and Execute = 1. For 443 * example, the value 444 * 0755 translates to User read-write, Group and 445 * Other read-only. 446 * <a 447 * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more 448 * on unix-style permissions)</a> 449 * 450 * @param directoryMode 451 */ 452 public void setDirectoryMode( String directoryMode ) 453 { 454 this.directoryMode = directoryMode; 455 } //-- void setDirectoryMode( String ) 456 457 /** 458 * Set when <exclude> subelements are present, they 459 * define a set of 460 * dependency artifact coordinates to exclude. If 461 * none is present, then 462 * <excludes> represents no exclusions. 463 * 464 * Artifact coordinatess may be given in simple 465 * groupId:artifactId form, 466 * or they may be fully qualified in the form 467 * groupId:artifactId:type:version[:classifier]. 468 * Additionally, wildcards can be used, as in 469 * *:maven-*. 470 * 471 * @param excludes 472 */ 473 public void setExcludes( java.util.List<String> excludes ) 474 { 475 this.excludes = excludes; 476 } //-- void setExcludes( java.util.List ) 477 478 /** 479 * Set similar to a UNIX permission, sets the file mode of the 480 * files included. 481 * THIS IS AN OCTAL VALUE. 482 * Format: (User)(Group)(Other) where each 483 * component is a sum of Read = 4, 484 * Write = 2, and Execute = 1. For example, the 485 * value 0644 486 * translates to User read-write, Group and Other 487 * read-only. 488 * <a 489 * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more 490 * on unix-style permissions)</a> 491 * 492 * @param fileMode 493 */ 494 public void setFileMode( String fileMode ) 495 { 496 this.fileMode = fileMode; 497 } //-- void setFileMode( String ) 498 499 /** 500 * Set if set to true, the plugin will include the direct and 501 * transitive dependencies of 502 * of the project modules included here. Otherwise, 503 * it will only include the module 504 * packages only. Default value is true. 505 * 506 * @param includeDependencies 507 */ 508 public void setIncludeDependencies( boolean includeDependencies ) 509 { 510 this.includeDependencies = includeDependencies; 511 } //-- void setIncludeDependencies( boolean ) 512 513 /** 514 * Set when <include> subelements are present, they 515 * define a set of 516 * artifact coordinates to include. If none is 517 * present, then 518 * <includes> represents all valid values. 519 * 520 * Artifact coordinatess may be given in simple 521 * groupId:artifactId form, 522 * or they may be fully qualified in the form 523 * groupId:artifactId:type:version[:classifier]. 524 * Additionally, wildcards can be used, as in 525 * *:maven-*. 526 * 527 * @param includes 528 */ 529 public void setIncludes( java.util.List<String> includes ) 530 { 531 this.includes = includes; 532 } //-- void setIncludes( java.util.List ) 533 534 /** 535 * Set sets the output directory relative to the root 536 * of the root directory of the assembly. For 537 * example, 538 * "log" will put the specified files in the log 539 * directory, 540 * directly beneath the root of the archive. 541 * 542 * @param outputDirectory 543 */ 544 public void setOutputDirectory( String outputDirectory ) 545 { 546 this.outputDirectory = outputDirectory; 547 } //-- void setOutputDirectory( String ) 548 549 /** 550 * Set sets the mapping pattern for all NON-UNPACKED 551 * dependencies included 552 * in this assembly. 553 * Default is 554 * ${module.artifactId}-${module.version}${dashClassifier?}.${module.extension}. 555 * (Since 2.2-beta-2; 2.2-beta-1 uses 556 * ${artifactId}-${version}${dashClassifier?}.${extension}) 557 * NOTE: If the 558 * dependencySet specifies unpack == true, 559 * outputFileNameMapping WILL NOT BE USED; in these cases, use 560 * outputDirectory. 561 * 562 * @param outputFileNameMapping 563 */ 564 public void setOutputFileNameMapping( String outputFileNameMapping ) 565 { 566 this.outputFileNameMapping = outputFileNameMapping; 567 } //-- void setOutputFileNameMapping( String ) 568 569 /** 570 * Set if set to true, this property will unpack all module 571 * packages 572 * into the specified output directory. When set to 573 * false 574 * module packages will be included as archives 575 * (jars). 576 * Default value is true. 577 * 578 * @param unpack 579 */ 580 public void setUnpack( boolean unpack ) 581 { 582 this.unpack = unpack; 583 } //-- void setUnpack( boolean ) 584 585 /** 586 * Set allows the specification of includes and excludes, along 587 * with filtering options, for items 588 * unpacked from a module artifact. (Since 2.2). 589 * 590 * @param unpackOptions 591 */ 592 public void setUnpackOptions( UnpackOptions unpackOptions ) 593 { 594 this.unpackOptions = unpackOptions; 595 } //-- void setUnpackOptions( UnpackOptions ) 596 597 }