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 * 11 * An assembly defines a collection of files usually 12 * distributed in an 13 * archive format such as zip, tar, or tar.gz that is 14 * generated from a 15 * project. For example, a project could produce a ZIP 16 * assembly which 17 * contains a project's JAR artifact in the root directory, 18 * the 19 * runtime dependencies in a lib/ directory, and a shell 20 * script to launch 21 * a stand-alone application. 22 * 23 * 24 * 25 * @version $Revision$ $Date$ 26 */ 27 @SuppressWarnings( "all" ) 28 public class Assembly 29 implements java.io.Serializable 30 { 31 32 //--------------------------/ 33 //- Class/Member Variables -/ 34 //--------------------------/ 35 36 /** 37 * 38 * Sets the id of this assembly. This is a symbolic 39 * name for a 40 * particular assembly of files from this project. 41 * Also, aside from 42 * being used to distinctly name the assembled 43 * package by attaching 44 * its value to the generated archive, the id is 45 * used as your 46 * artifact's classifier when deploying. 47 * 48 */ 49 private String id; 50 51 /** 52 * Field formats. 53 */ 54 private java.util.List<String> formats; 55 56 /** 57 * 58 * Includes a base directory in the final archive. 59 * For example, 60 * if you are creating an assembly named 61 * "your-app", setting 62 * includeBaseDirectory to true will create an 63 * archive that 64 * includes this base directory. If this option is 65 * set to false 66 * the archive created will unzip its content to 67 * the current 68 * directory. 69 * 70 */ 71 private boolean includeBaseDirectory = true; 72 73 /** 74 * 75 * Sets the base directory of the resulting 76 * assembly archive. If this is not 77 * set and includeBaseDirectory == true, 78 * ${project.build.finalName} will be used instead. 79 * (Since 2.2-beta-1) 80 * . 81 */ 82 private String baseDirectory; 83 84 /** 85 * 86 * Includes a site directory in the final archive. 87 * The site directory 88 * location of a project is determined by the 89 * siteDirectory parameter 90 * of the Assembly Plugin. 91 * 92 */ 93 private boolean includeSiteDirectory = false; 94 95 /** 96 * Field containerDescriptorHandlers. 97 */ 98 private java.util.List<ContainerDescriptorHandlerConfig> containerDescriptorHandlers; 99 100 /** 101 * Field moduleSets. 102 */ 103 private java.util.List<ModuleSet> moduleSets; 104 105 /** 106 * Field fileSets. 107 */ 108 private java.util.List<FileSet> fileSets; 109 110 /** 111 * Field files. 112 */ 113 private java.util.List<FileItem> files; 114 115 /** 116 * Field dependencySets. 117 */ 118 private java.util.List<DependencySet> dependencySets; 119 120 /** 121 * Field repositories. 122 */ 123 private java.util.List<Repository> repositories; 124 125 /** 126 * Field componentDescriptors. 127 */ 128 private java.util.List<String> componentDescriptors; 129 130 /** 131 * Field modelEncoding. 132 */ 133 private String modelEncoding = "UTF-8"; 134 135 136 //-----------/ 137 //- Methods -/ 138 //-----------/ 139 140 /** 141 * Method addComponentDescriptor. 142 * 143 * @param string 144 */ 145 public void addComponentDescriptor( String string ) 146 { 147 getComponentDescriptors().add( string ); 148 } //-- void addComponentDescriptor( String ) 149 150 /** 151 * Method addContainerDescriptorHandler. 152 * 153 * @param containerDescriptorHandlerConfig 154 */ 155 public void addContainerDescriptorHandler( ContainerDescriptorHandlerConfig containerDescriptorHandlerConfig ) 156 { 157 getContainerDescriptorHandlers().add( containerDescriptorHandlerConfig ); 158 } //-- void addContainerDescriptorHandler( ContainerDescriptorHandlerConfig ) 159 160 /** 161 * Method addDependencySet. 162 * 163 * @param dependencySet 164 */ 165 public void addDependencySet( DependencySet dependencySet ) 166 { 167 getDependencySets().add( dependencySet ); 168 } //-- void addDependencySet( DependencySet ) 169 170 /** 171 * Method addFile. 172 * 173 * @param fileItem 174 */ 175 public void addFile( FileItem fileItem ) 176 { 177 getFiles().add( fileItem ); 178 } //-- void addFile( FileItem ) 179 180 /** 181 * Method addFileSet. 182 * 183 * @param fileSet 184 */ 185 public void addFileSet( FileSet fileSet ) 186 { 187 getFileSets().add( fileSet ); 188 } //-- void addFileSet( FileSet ) 189 190 /** 191 * Method addFormat. 192 * 193 * @param string 194 */ 195 public void addFormat( String string ) 196 { 197 getFormats().add( string ); 198 } //-- void addFormat( String ) 199 200 /** 201 * Method addModuleSet. 202 * 203 * @param moduleSet 204 */ 205 public void addModuleSet( ModuleSet moduleSet ) 206 { 207 getModuleSets().add( moduleSet ); 208 } //-- void addModuleSet( ModuleSet ) 209 210 /** 211 * Method addRepository. 212 * 213 * @param repository 214 */ 215 public void addRepository( Repository repository ) 216 { 217 getRepositories().add( repository ); 218 } //-- void addRepository( Repository ) 219 220 /** 221 * Get sets the base directory of the resulting assembly 222 * archive. If this is not 223 * set and includeBaseDirectory == true, 224 * ${project.build.finalName} will be used instead. 225 * (Since 2.2-beta-1). 226 * 227 * @return String 228 */ 229 public String getBaseDirectory() 230 { 231 return this.baseDirectory; 232 } //-- String getBaseDirectory() 233 234 /** 235 * Method getComponentDescriptors. 236 * 237 * @return List 238 */ 239 public java.util.List<String> getComponentDescriptors() 240 { 241 if ( this.componentDescriptors == null ) 242 { 243 this.componentDescriptors = new java.util.ArrayList<String>(); 244 } 245 246 return this.componentDescriptors; 247 } //-- java.util.List<String> getComponentDescriptors() 248 249 /** 250 * Method getContainerDescriptorHandlers. 251 * 252 * @return List 253 */ 254 public java.util.List<ContainerDescriptorHandlerConfig> getContainerDescriptorHandlers() 255 { 256 if ( this.containerDescriptorHandlers == null ) 257 { 258 this.containerDescriptorHandlers = new java.util.ArrayList<ContainerDescriptorHandlerConfig>(); 259 } 260 261 return this.containerDescriptorHandlers; 262 } //-- java.util.List<ContainerDescriptorHandlerConfig> getContainerDescriptorHandlers() 263 264 /** 265 * Method getDependencySets. 266 * 267 * @return List 268 */ 269 public java.util.List<DependencySet> getDependencySets() 270 { 271 if ( this.dependencySets == null ) 272 { 273 this.dependencySets = new java.util.ArrayList<DependencySet>(); 274 } 275 276 return this.dependencySets; 277 } //-- java.util.List<DependencySet> getDependencySets() 278 279 /** 280 * Method getFileSets. 281 * 282 * @return List 283 */ 284 public java.util.List<FileSet> getFileSets() 285 { 286 if ( this.fileSets == null ) 287 { 288 this.fileSets = new java.util.ArrayList<FileSet>(); 289 } 290 291 return this.fileSets; 292 } //-- java.util.List<FileSet> getFileSets() 293 294 /** 295 * Method getFiles. 296 * 297 * @return List 298 */ 299 public java.util.List<FileItem> getFiles() 300 { 301 if ( this.files == null ) 302 { 303 this.files = new java.util.ArrayList<FileItem>(); 304 } 305 306 return this.files; 307 } //-- java.util.List<FileItem> getFiles() 308 309 /** 310 * Method getFormats. 311 * 312 * @return List 313 */ 314 public java.util.List<String> getFormats() 315 { 316 if ( this.formats == null ) 317 { 318 this.formats = new java.util.ArrayList<String>(); 319 } 320 321 return this.formats; 322 } //-- java.util.List<String> getFormats() 323 324 /** 325 * Get sets the id of this assembly. This is a symbolic name 326 * for a 327 * particular assembly of files from this project. 328 * Also, aside from 329 * being used to distinctly name the assembled 330 * package by attaching 331 * its value to the generated archive, the id is 332 * used as your 333 * artifact's classifier when deploying. 334 * 335 * @return String 336 */ 337 public String getId() 338 { 339 return this.id; 340 } //-- String getId() 341 342 /** 343 * Get the modelEncoding field. 344 * 345 * @return String 346 */ 347 public String getModelEncoding() 348 { 349 return this.modelEncoding; 350 } //-- String getModelEncoding() 351 352 /** 353 * Method getModuleSets. 354 * 355 * @return List 356 */ 357 public java.util.List<ModuleSet> getModuleSets() 358 { 359 if ( this.moduleSets == null ) 360 { 361 this.moduleSets = new java.util.ArrayList<ModuleSet>(); 362 } 363 364 return this.moduleSets; 365 } //-- java.util.List<ModuleSet> getModuleSets() 366 367 /** 368 * Method getRepositories. 369 * 370 * @return List 371 */ 372 public java.util.List<Repository> getRepositories() 373 { 374 if ( this.repositories == null ) 375 { 376 this.repositories = new java.util.ArrayList<Repository>(); 377 } 378 379 return this.repositories; 380 } //-- java.util.List<Repository> getRepositories() 381 382 /** 383 * Get includes a base directory in the final archive. For 384 * example, 385 * if you are creating an assembly named 386 * "your-app", setting 387 * includeBaseDirectory to true will create an 388 * archive that 389 * includes this base directory. If this option is 390 * set to false 391 * the archive created will unzip its content to 392 * the current 393 * directory. 394 * 395 * @return boolean 396 */ 397 public boolean isIncludeBaseDirectory() 398 { 399 return this.includeBaseDirectory; 400 } //-- boolean isIncludeBaseDirectory() 401 402 /** 403 * Get includes a site directory in the final archive. The site 404 * directory 405 * location of a project is determined by the 406 * siteDirectory parameter 407 * of the Assembly Plugin. 408 * 409 * @return boolean 410 */ 411 public boolean isIncludeSiteDirectory() 412 { 413 return this.includeSiteDirectory; 414 } //-- boolean isIncludeSiteDirectory() 415 416 /** 417 * Method removeComponentDescriptor. 418 * 419 * @param string 420 */ 421 public void removeComponentDescriptor( String string ) 422 { 423 getComponentDescriptors().remove( string ); 424 } //-- void removeComponentDescriptor( String ) 425 426 /** 427 * Method removeContainerDescriptorHandler. 428 * 429 * @param containerDescriptorHandlerConfig 430 */ 431 public void removeContainerDescriptorHandler( ContainerDescriptorHandlerConfig containerDescriptorHandlerConfig ) 432 { 433 getContainerDescriptorHandlers().remove( containerDescriptorHandlerConfig ); 434 } //-- void removeContainerDescriptorHandler( ContainerDescriptorHandlerConfig ) 435 436 /** 437 * Method removeDependencySet. 438 * 439 * @param dependencySet 440 */ 441 public void removeDependencySet( DependencySet dependencySet ) 442 { 443 getDependencySets().remove( dependencySet ); 444 } //-- void removeDependencySet( DependencySet ) 445 446 /** 447 * Method removeFile. 448 * 449 * @param fileItem 450 */ 451 public void removeFile( FileItem fileItem ) 452 { 453 getFiles().remove( fileItem ); 454 } //-- void removeFile( FileItem ) 455 456 /** 457 * Method removeFileSet. 458 * 459 * @param fileSet 460 */ 461 public void removeFileSet( FileSet fileSet ) 462 { 463 getFileSets().remove( fileSet ); 464 } //-- void removeFileSet( FileSet ) 465 466 /** 467 * Method removeFormat. 468 * 469 * @param string 470 */ 471 public void removeFormat( String string ) 472 { 473 getFormats().remove( string ); 474 } //-- void removeFormat( String ) 475 476 /** 477 * Method removeModuleSet. 478 * 479 * @param moduleSet 480 */ 481 public void removeModuleSet( ModuleSet moduleSet ) 482 { 483 getModuleSets().remove( moduleSet ); 484 } //-- void removeModuleSet( ModuleSet ) 485 486 /** 487 * Method removeRepository. 488 * 489 * @param repository 490 */ 491 public void removeRepository( Repository repository ) 492 { 493 getRepositories().remove( repository ); 494 } //-- void removeRepository( Repository ) 495 496 /** 497 * Set sets the base directory of the resulting assembly 498 * archive. If this is not 499 * set and includeBaseDirectory == true, 500 * ${project.build.finalName} will be used instead. 501 * (Since 2.2-beta-1). 502 * 503 * @param baseDirectory 504 */ 505 public void setBaseDirectory( String baseDirectory ) 506 { 507 this.baseDirectory = baseDirectory; 508 } //-- void setBaseDirectory( String ) 509 510 /** 511 * Set specifies the shared components xml file locations to 512 * include in the 513 * assembly. The locations specified must be 514 * relative to the base location 515 * of the descriptor. If the descriptor was found 516 * via a <descriptorRef/> 517 * element in the 518 * classpath, any components it specifies will also 519 * be found on the classpath. 520 * If it is found by pathname via a 521 * <descriptor/> element 522 * the value here will be interpreted 523 * as a path relative to the project basedir. 524 * When multiple componentDescriptors are found, 525 * their 526 * contents are merged. Check out the <a 527 * href="assembly-component.html"> 528 * descriptor components</a> for more information. 529 * A 530 * componentDescriptor is specified by providing 531 * one or more of 532 * <componentDescriptor> subelements. 533 * 534 * @param componentDescriptors 535 */ 536 public void setComponentDescriptors( java.util.List<String> componentDescriptors ) 537 { 538 this.componentDescriptors = componentDescriptors; 539 } //-- void setComponentDescriptors( java.util.List ) 540 541 /** 542 * Set set of components which filter various container 543 * descriptors out of 544 * the normal archive stream, so they can be 545 * aggregated then added. 546 * 547 * @param containerDescriptorHandlers 548 */ 549 public void setContainerDescriptorHandlers( java.util.List<ContainerDescriptorHandlerConfig> containerDescriptorHandlers ) 550 { 551 this.containerDescriptorHandlers = containerDescriptorHandlers; 552 } //-- void setContainerDescriptorHandlers( java.util.List ) 553 554 /** 555 * Set specifies which dependencies to include in the assembly. 556 * A 557 * dependencySet is specified by providing one or 558 * more of 559 * <dependencySet> subelements. 560 * 561 * @param dependencySets 562 */ 563 public void setDependencySets( java.util.List<DependencySet> dependencySets ) 564 { 565 this.dependencySets = dependencySets; 566 } //-- void setDependencySets( java.util.List ) 567 568 /** 569 * Set specifies which groups of files to include in the 570 * assembly. A 571 * fileSet is specified by providing one or more of 572 * <fileSet> 573 * subelements. 574 * 575 * @param fileSets 576 */ 577 public void setFileSets( java.util.List<FileSet> fileSets ) 578 { 579 this.fileSets = fileSets; 580 } //-- void setFileSets( java.util.List ) 581 582 /** 583 * Set specifies which single files to include in the assembly. 584 * A file 585 * is specified by providing one or more of 586 * <file> 587 * subelements. 588 * 589 * @param files 590 */ 591 public void setFiles( java.util.List<FileItem> files ) 592 { 593 this.files = files; 594 } //-- void setFiles( java.util.List ) 595 596 /** 597 * Set specifies the formats of the assembly. 598 * 599 * It is often better to specify the formats via 600 * the goal parameter rather 601 * than here. For example, that allows different 602 * profiles to generate 603 * different types of archives. 604 * 605 * Multiple formats can be 606 * supplied and the Assembly Plugin will generate 607 * an archive for each 608 * of the desired formats. When deploying your 609 * project, all file formats 610 * specified will also be deployed. A format is 611 * specified by supplying 612 * one of the following values in a <format> 613 * subelement: 614 * <ul> 615 * <li><b>"zip"</b> - Creates a ZIP file 616 * format</li> 617 * <li><b>"tar"</b> - Creates a TAR format</li> 618 * <li><b>"tar.gz"</b> or <b>"tgz"</b> - Creates 619 * a gzip'd TAR format</li> 620 * <li><b>"tar.bz2"</b> or <b>"tbz2"</b> - 621 * Creates a bzip'd TAR format</li> 622 * <li><b>"tar.snappy"</b> - Creates a snappy'd 623 * TAR format</li> 624 * <li><b>"tar.xz"</b> or <b>"txz"</b> - Creates 625 * a xz'd TAR format</li> 626 * <li><b>"jar"</b> - Creates a JAR format</li> 627 * <li><b>"dir"</b> - Creates an exploded 628 * directory format</li> 629 * <li><b>"war"</b> - Creates a WAR format</li> 630 * </ul> 631 * 632 * @param formats 633 */ 634 public void setFormats( java.util.List<String> formats ) 635 { 636 this.formats = formats; 637 } //-- void setFormats( java.util.List ) 638 639 /** 640 * Set sets the id of this assembly. This is a symbolic name 641 * for a 642 * particular assembly of files from this project. 643 * Also, aside from 644 * being used to distinctly name the assembled 645 * package by attaching 646 * its value to the generated archive, the id is 647 * used as your 648 * artifact's classifier when deploying. 649 * 650 * @param id 651 */ 652 public void setId( String id ) 653 { 654 this.id = id; 655 } //-- void setId( String ) 656 657 /** 658 * Set includes a base directory in the final archive. For 659 * example, 660 * if you are creating an assembly named 661 * "your-app", setting 662 * includeBaseDirectory to true will create an 663 * archive that 664 * includes this base directory. If this option is 665 * set to false 666 * the archive created will unzip its content to 667 * the current 668 * directory. 669 * 670 * @param includeBaseDirectory 671 */ 672 public void setIncludeBaseDirectory( boolean includeBaseDirectory ) 673 { 674 this.includeBaseDirectory = includeBaseDirectory; 675 } //-- void setIncludeBaseDirectory( boolean ) 676 677 /** 678 * Set includes a site directory in the final archive. The site 679 * directory 680 * location of a project is determined by the 681 * siteDirectory parameter 682 * of the Assembly Plugin. 683 * 684 * @param includeSiteDirectory 685 */ 686 public void setIncludeSiteDirectory( boolean includeSiteDirectory ) 687 { 688 this.includeSiteDirectory = includeSiteDirectory; 689 } //-- void setIncludeSiteDirectory( boolean ) 690 691 /** 692 * Set the modelEncoding field. 693 * 694 * @param modelEncoding 695 */ 696 public void setModelEncoding( String modelEncoding ) 697 { 698 this.modelEncoding = modelEncoding; 699 } //-- void setModelEncoding( String ) 700 701 /** 702 * Set specifies which module files to include in the assembly. 703 * A moduleSet 704 * is specified by providing one or more of 705 * <moduleSet> 706 * subelements. 707 * 708 * @param moduleSets 709 */ 710 public void setModuleSets( java.util.List<ModuleSet> moduleSets ) 711 { 712 this.moduleSets = moduleSets; 713 } //-- void setModuleSets( java.util.List ) 714 715 /** 716 * Set specifies which repository files to include in the 717 * assembly. A 718 * repository is specified by providing one or more 719 * of 720 * <repository> subelements. 721 * 722 * @param repositories 723 */ 724 public void setRepositories( java.util.List<Repository> repositories ) 725 { 726 this.repositories = repositories; 727 } //-- void setRepositories( java.util.List ) 728 729 }