1 // =================== DO NOT EDIT THIS FILE ==================== 2 // Generated by Modello 1.8.3, 3 // any modifications will be overwritten. 4 // ============================================================== 5 6 package org.apache.maven.plugins.assembly.model; 7 8 /** 9 * 10 * Contains configuration options for including the binary 11 * files of a 12 * project module in an assembly. 13 * 14 * 15 * @version $Revision$ $Date$ 16 */ 17 @SuppressWarnings( "all" ) 18 public class ModuleBinaries 19 implements java.io.Serializable 20 { 21 22 //--------------------------/ 23 //- Class/Member Variables -/ 24 //--------------------------/ 25 26 /** 27 * 28 * Sets the output directory relative to the root 29 * of the root directory of the assembly. For 30 * example, 31 * "log" will put the specified files in the log 32 * directory, 33 * directly beneath the root of the archive. 34 * 35 */ 36 private String outputDirectory; 37 38 /** 39 * Field includes. 40 */ 41 private java.util.List<String> includes; 42 43 /** 44 * Field excludes. 45 */ 46 private java.util.List<String> excludes; 47 48 /** 49 * 50 * 51 * Similar to a UNIX permission, sets the file mode 52 * of the files included. 53 * THIS IS AN OCTAL VALUE. 54 * Format: (User)(Group)(Other) where each 55 * component is a sum of Read = 4, 56 * Write = 2, and Execute = 1. For example, the 57 * value 0644 58 * translates to User read-write, Group and Other 59 * read-only. The default value is 0644. 60 * <a 61 * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more 62 * on unix-style permissions)</a> 63 * 64 * 65 */ 66 private String fileMode; 67 68 /** 69 * 70 * 71 * Similar to a UNIX permission, sets the directory 72 * mode of the directories 73 * included. 74 * THIS IS AN OCTAL VALUE. 75 * Format: (User)(Group)(Other) where each 76 * component is a sum of 77 * Read = 4, Write = 2, and Execute = 1. For 78 * example, the value 79 * 0755 translates to User read-write, Group and 80 * Other read-only. The default value is 0755. 81 * <a 82 * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more 83 * on unix-style permissions)</a> 84 * 85 * 86 */ 87 private String directoryMode; 88 89 /** 90 * 91 * When specified, the attachmentClassifier will 92 * cause the assembler to look at artifacts 93 * attached to the module instead of the main project 94 * artifact. If it can find an attached 95 * artifact matching the specified classifier, it 96 * will use it; otherwise, it will throw an 97 * exception. (Since 2.2) 98 * . 99 */ 100 private String attachmentClassifier; 101 102 /** 103 * 104 * If set to true, the plugin will include the direct 105 * and transitive dependencies of 106 * of the project modules included here. Otherwise, 107 * it will only include the module 108 * packages only. Default value is true. 109 * 110 */ 111 private boolean includeDependencies = true; 112 113 /** 114 * Field dependencySets. 115 */ 116 private java.util.List<DependencySet> dependencySets; 117 118 /** 119 * 120 * If set to true, this property will unpack all 121 * module packages 122 * into the specified output directory. When set to 123 * false 124 * module packages will be included as archives 125 * (jars). 126 * Default value is true. 127 * 128 */ 129 private boolean unpack = true; 130 131 /** 132 * 133 * Allows the specification of includes and excludes, 134 * along with filtering options, for items 135 * unpacked from a module artifact. (Since 2.2) 136 * . 137 */ 138 private UnpackOptions unpackOptions; 139 140 /** 141 * 142 * Sets the mapping pattern for all NON-UNPACKED 143 * dependencies included 144 * in this assembly. 145 * Default is 146 * ${module.artifactId}-${module.version}${dashClassifier?}.${module.extension}. 147 * (Since 2.2-beta-2; 2.2-beta-1 uses 148 * ${artifactId}-${version}${dashClassifier?}.${extension}) 149 * NOTE: If the 150 * dependencySet specifies unpack == true, 151 * outputFileNameMapping WILL NOT BE USED; in these cases, use 152 * outputDirectory. 153 * See the plugin FAQ for more details about 154 * entries usable in the outputFileNameMapping parameter. 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. The default value is 0755. 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. The default value is 0644. 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 * See the plugin FAQ for more details about 326 * entries usable in the outputFileNameMapping parameter. 327 * 328 * @return String 329 */ 330 public String getOutputFileNameMapping() 331 { 332 return this.outputFileNameMapping; 333 } //-- String getOutputFileNameMapping() 334 335 /** 336 * Get allows the specification of includes and excludes, along 337 * with filtering options, for items 338 * unpacked from a module artifact. (Since 2.2). 339 * 340 * @return UnpackOptions 341 */ 342 public UnpackOptions getUnpackOptions() 343 { 344 return this.unpackOptions; 345 } //-- UnpackOptions getUnpackOptions() 346 347 /** 348 * Get if set to true, the plugin will include the direct and 349 * transitive dependencies of 350 * of the project modules included here. Otherwise, 351 * it will only include the module 352 * packages only. Default value is true. 353 * 354 * @return boolean 355 */ 356 public boolean isIncludeDependencies() 357 { 358 return this.includeDependencies; 359 } //-- boolean isIncludeDependencies() 360 361 /** 362 * Get if set to true, this property will unpack all module 363 * packages 364 * into the specified output directory. When set to 365 * false 366 * module packages will be included as archives 367 * (jars). 368 * Default value is true. 369 * 370 * @return boolean 371 */ 372 public boolean isUnpack() 373 { 374 return this.unpack; 375 } //-- boolean isUnpack() 376 377 /** 378 * Method removeDependencySet. 379 * 380 * @param dependencySet 381 */ 382 public void removeDependencySet( DependencySet dependencySet ) 383 { 384 getDependencySets().remove( dependencySet ); 385 } //-- void removeDependencySet( DependencySet ) 386 387 /** 388 * Method removeExclude. 389 * 390 * @param string 391 */ 392 public void removeExclude( String string ) 393 { 394 getExcludes().remove( string ); 395 } //-- void removeExclude( String ) 396 397 /** 398 * Method removeInclude. 399 * 400 * @param string 401 */ 402 public void removeInclude( String string ) 403 { 404 getIncludes().remove( string ); 405 } //-- void removeInclude( String ) 406 407 /** 408 * Set when specified, the attachmentClassifier will cause the 409 * assembler to look at artifacts 410 * attached to the module instead of the main project 411 * artifact. If it can find an attached 412 * artifact matching the specified classifier, it 413 * will use it; otherwise, it will throw an 414 * exception. (Since 2.2). 415 * 416 * @param attachmentClassifier 417 */ 418 public void setAttachmentClassifier( String attachmentClassifier ) 419 { 420 this.attachmentClassifier = attachmentClassifier; 421 } //-- void setAttachmentClassifier( String ) 422 423 /** 424 * Set specifies which dependencies of the module to include in 425 * the assembly. A 426 * dependencySet is specified by providing one or 427 * more of 428 * <dependencySet> subelements. (Since 2.2). 429 * 430 * @param dependencySets 431 */ 432 public void setDependencySets( java.util.List<DependencySet> dependencySets ) 433 { 434 this.dependencySets = dependencySets; 435 } //-- void setDependencySets( java.util.List ) 436 437 /** 438 * Set similar to a UNIX permission, sets the directory mode of 439 * the directories 440 * included. 441 * THIS IS AN OCTAL VALUE. 442 * Format: (User)(Group)(Other) where each 443 * component is a sum of 444 * Read = 4, Write = 2, and Execute = 1. For 445 * example, the value 446 * 0755 translates to User read-write, Group and 447 * Other read-only. The default value is 0755. 448 * <a 449 * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more 450 * on unix-style permissions)</a> 451 * 452 * @param directoryMode 453 */ 454 public void setDirectoryMode( String directoryMode ) 455 { 456 this.directoryMode = directoryMode; 457 } //-- void setDirectoryMode( String ) 458 459 /** 460 * Set when <exclude> subelements are present, they 461 * define a set of 462 * dependency artifact coordinates to exclude. If 463 * none is present, then 464 * <excludes> represents no exclusions. 465 * 466 * Artifact coordinates may be given in simple 467 * groupId:artifactId form, 468 * or they may be fully qualified in the form 469 * groupId:artifactId:type[:classifier]:version. 470 * Additionally, wildcards can be used, as in 471 * *:maven-*. 472 * 473 * @param excludes 474 */ 475 public void setExcludes( java.util.List<String> excludes ) 476 { 477 this.excludes = excludes; 478 } //-- void setExcludes( java.util.List ) 479 480 /** 481 * Set similar to a UNIX permission, sets the file mode of the 482 * files included. 483 * THIS IS AN OCTAL VALUE. 484 * Format: (User)(Group)(Other) where each 485 * component is a sum of Read = 4, 486 * Write = 2, and Execute = 1. For example, the 487 * value 0644 488 * translates to User read-write, Group and Other 489 * read-only. The default value is 0644. 490 * <a 491 * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more 492 * on unix-style permissions)</a> 493 * 494 * @param fileMode 495 */ 496 public void setFileMode( String fileMode ) 497 { 498 this.fileMode = fileMode; 499 } //-- void setFileMode( String ) 500 501 /** 502 * Set if set to true, the plugin will include the direct and 503 * transitive dependencies of 504 * of the project modules included here. Otherwise, 505 * it will only include the module 506 * packages only. Default value is true. 507 * 508 * @param includeDependencies 509 */ 510 public void setIncludeDependencies( boolean includeDependencies ) 511 { 512 this.includeDependencies = includeDependencies; 513 } //-- void setIncludeDependencies( boolean ) 514 515 /** 516 * Set when <include> subelements are present, they 517 * define a set of 518 * artifact coordinates to include. If none is 519 * present, then 520 * <includes> represents all valid values. 521 * 522 * Artifact coordinates may be given in simple 523 * groupId:artifactId form, 524 * or they may be fully qualified in the form 525 * groupId:artifactId:type[:classifier]:version. 526 * Additionally, wildcards can be used, as in 527 * *:maven-*. 528 * 529 * @param includes 530 */ 531 public void setIncludes( java.util.List<String> includes ) 532 { 533 this.includes = includes; 534 } //-- void setIncludes( java.util.List ) 535 536 /** 537 * Set sets the output directory relative to the root 538 * of the root directory of the assembly. For 539 * example, 540 * "log" will put the specified files in the log 541 * directory, 542 * directly beneath the root of the archive. 543 * 544 * @param outputDirectory 545 */ 546 public void setOutputDirectory( String outputDirectory ) 547 { 548 this.outputDirectory = outputDirectory; 549 } //-- void setOutputDirectory( String ) 550 551 /** 552 * Set sets the mapping pattern for all NON-UNPACKED 553 * dependencies included 554 * in this assembly. 555 * Default is 556 * ${module.artifactId}-${module.version}${dashClassifier?}.${module.extension}. 557 * (Since 2.2-beta-2; 2.2-beta-1 uses 558 * ${artifactId}-${version}${dashClassifier?}.${extension}) 559 * NOTE: If the 560 * dependencySet specifies unpack == true, 561 * outputFileNameMapping WILL NOT BE USED; in these cases, use 562 * outputDirectory. 563 * See the plugin FAQ for more details about 564 * entries usable in the outputFileNameMapping parameter. 565 * 566 * @param outputFileNameMapping 567 */ 568 public void setOutputFileNameMapping( String outputFileNameMapping ) 569 { 570 this.outputFileNameMapping = outputFileNameMapping; 571 } //-- void setOutputFileNameMapping( String ) 572 573 /** 574 * Set if set to true, this property will unpack all module 575 * packages 576 * into the specified output directory. When set to 577 * false 578 * module packages will be included as archives 579 * (jars). 580 * Default value is true. 581 * 582 * @param unpack 583 */ 584 public void setUnpack( boolean unpack ) 585 { 586 this.unpack = unpack; 587 } //-- void setUnpack( boolean ) 588 589 /** 590 * Set allows the specification of includes and excludes, along 591 * with filtering options, for items 592 * unpacked from a module artifact. (Since 2.2). 593 * 594 * @param unpackOptions 595 */ 596 public void setUnpackOptions( UnpackOptions unpackOptions ) 597 { 598 this.unpackOptions = unpackOptions; 599 } //-- void setUnpackOptions( UnpackOptions ) 600 601 }