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