1 /* 2 =================== DO NOT EDIT THIS FILE ==================== 3 Generated by Modello 1.5 on 2015-06-17 12:02:34, 4 any modifications will be overwritten. 5 ============================================================== 6 */ 7 8 package org.codehaus.mojo.nbm.model; 9 10 /** 11 * Describes the layout, dependencies and packaging of a NetBeans 12 * module. 13 * 14 * @version $Revision$ $Date$ 15 */ 16 @SuppressWarnings( "all" ) 17 public class NetBeansModule 18 implements java.io.Serializable 19 { 20 21 //--------------------------/ 22 //- Class/Member Variables -/ 23 //--------------------------/ 24 25 /** 26 * 27 * <p>DEPRECATED, use the plugin 28 * configuration instead. Type of the module. Possible values 29 * are </p> 30 * <p><b>autoload</b> - Such a module is 31 * automatically enabled when some other module requires it and 32 * automatically disabled otherwise.</p> 33 * <p><b>eager</b> - This module type gets 34 * automatically enabled when all it's dependencies are 35 * satisfied. Disabled otherwise.</p> 36 * <p><b>normal</b> - This is the default 37 * value. This kind of module is enabled/disabled manually by 38 * the user. It installs enabled.</p> 39 * 40 */ 41 @Deprecated 42 private String moduleType; 43 44 /** 45 * DEPRECATED, use the plugin configuration instead. 46 * Codenamebase of the module. Primary identification of the 47 * module. Usually the package name. Eg. 48 * "org.codehaus.mevenide.project". 49 * If not defined here, the default value 50 * is constructed from groupId and artifactId. 51 */ 52 @Deprecated 53 private String codeNameBase; 54 55 /** 56 * DEPRECATED, use the plugin configuration instead. Each 57 * modules should belong to a cluster. A cluster is a group of 58 * related modules. For individual modules it's not that 59 * important. Refer to netbeans.org documentation for more 60 * details. 61 */ 62 @Deprecated 63 private String cluster; 64 65 /** 66 * DEPRECATED, use the plugin configuration instead. Determines 67 * if the module requires restart of the IDE/platform upon 68 * installation. 69 */ 70 @Deprecated 71 private boolean requiresRestart = false; 72 73 /** 74 * DEPRECATED, use the plugin configuration instead. Location 75 * of the manifest file with NetBeans specific manifest 76 * entries. 77 * 78 */ 79 @Deprecated 80 private String manifest; 81 82 /** 83 * DEPRECATED, use the plugin configuration instead. Homepage 84 * URL of the module. Is accessible from NetBeans UI upon 85 * installation, should point to place with additional 86 * information about the functionality. If not defined, it 87 * defaults to POM's url element. 88 */ 89 @Deprecated 90 private String homepageUrl; 91 92 /** 93 * DEPRECATED, use the plugin configuration instead. Http URL 94 * of the location where the module can be downloaded from the 95 * internet. This value put into the NBM and used when 96 * generating the Autoupdate Site. Should point directly to the 97 * NBM download. 98 */ 99 @Deprecated 100 private String distributionUrl; 101 102 /** 103 * DEPRECATED, use the plugin configuration instead. Author of 104 * the module. Is used when generating the NBM file. 105 */ 106 @Deprecated 107 private String author; 108 109 /** 110 * DEPRECATED, use the plugin configuration instead. Name of 111 * the license. If the user already agreed to the same license 112 * before, he/she won't be asked again to agree. 113 */ 114 @Deprecated 115 private String licenseName; 116 117 /** 118 * DEPRECATED, use the plugin configuration instead. Path to 119 * the license agreement file. 120 */ 121 @Deprecated 122 private String licenseFile; 123 124 /** 125 * Field libraries. 126 */ 127 private java.util.List<String> libraries; 128 129 /** 130 * Field dependencies. 131 */ 132 private java.util.List<Dependency> dependencies; 133 134 /** 135 * Field nbmResources. 136 */ 137 @Deprecated 138 private java.util.List<NbmResource> nbmResources; 139 140 /** 141 * Field modelEncoding. 142 */ 143 private String modelEncoding = "UTF-8"; 144 145 146 //-----------/ 147 //- Methods -/ 148 //-----------/ 149 150 /** 151 * Method addDependency. 152 * 153 * @param dependency 154 */ 155 public void addDependency( Dependency dependency ) 156 { 157 getDependencies().add( dependency ); 158 } //-- void addDependency( Dependency ) 159 160 /** 161 * Method addLibrary. 162 * 163 * @param string 164 */ 165 public void addLibrary( String string ) 166 { 167 getLibraries().add( string ); 168 } //-- void addLibrary( String ) 169 170 /** 171 * Method addNbmResource. 172 * 173 * @param nbmResource 174 */ 175 public void addNbmResource( NbmResource nbmResource ) 176 { 177 getNbmResources().add( nbmResource ); 178 } //-- void addNbmResource( NbmResource ) 179 180 /** 181 * Get dEPRECATED, use the plugin configuration instead. Author 182 * of the module. Is used when generating the NBM file. 183 * 184 * @return String 185 */ 186 public String getAuthor() 187 { 188 return this.author; 189 } //-- String getAuthor() 190 191 /** 192 * Get dEPRECATED, use the plugin configuration instead. Each 193 * modules should belong to a cluster. A cluster is a group of 194 * related modules. For individual modules it's not that 195 * important. Refer to netbeans.org documentation for more 196 * details. 197 * 198 * @return String 199 */ 200 public String getCluster() 201 { 202 return this.cluster; 203 } //-- String getCluster() 204 205 /** 206 * Get dEPRECATED, use the plugin configuration instead. 207 * Codenamebase of the module. Primary identification of the 208 * module. Usually the package name. Eg. 209 * "org.codehaus.mevenide.project". 210 * If not defined here, the default value 211 * is constructed from groupId and artifactId. 212 * 213 * @return String 214 */ 215 public String getCodeNameBase() 216 { 217 return this.codeNameBase; 218 } //-- String getCodeNameBase() 219 220 /** 221 * Method getDependencies. 222 * 223 * @return List 224 */ 225 public java.util.List<Dependency> getDependencies() 226 { 227 if ( this.dependencies == null ) 228 { 229 this.dependencies = new java.util.ArrayList<Dependency>(); 230 } 231 232 return this.dependencies; 233 } //-- java.util.List<Dependency> getDependencies() 234 235 /** 236 * Get dEPRECATED, use the plugin configuration instead. Http 237 * URL of the location where the module can be downloaded from 238 * the internet. This value put into the NBM and used when 239 * generating the Autoupdate Site. Should point directly to the 240 * NBM download. 241 * 242 * @return String 243 */ 244 public String getDistributionUrl() 245 { 246 return this.distributionUrl; 247 } //-- String getDistributionUrl() 248 249 /** 250 * Get dEPRECATED, use the plugin configuration instead. 251 * Homepage URL of the module. Is accessible from NetBeans UI 252 * upon installation, should point to place with additional 253 * information about the functionality. If not defined, it 254 * defaults to POM's url element. 255 * 256 * @return String 257 */ 258 public String getHomepageUrl() 259 { 260 return this.homepageUrl; 261 } //-- String getHomepageUrl() 262 263 /** 264 * Method getLibraries. 265 * 266 * @return List 267 */ 268 public java.util.List<String> getLibraries() 269 { 270 if ( this.libraries == null ) 271 { 272 this.libraries = new java.util.ArrayList<String>(); 273 } 274 275 return this.libraries; 276 } //-- java.util.List<String> getLibraries() 277 278 /** 279 * Get dEPRECATED, use the plugin configuration instead. Path 280 * to the license agreement file. 281 * 282 * @return String 283 */ 284 public String getLicenseFile() 285 { 286 return this.licenseFile; 287 } //-- String getLicenseFile() 288 289 /** 290 * Get dEPRECATED, use the plugin configuration instead. Name 291 * of the license. If the user already agreed to the same 292 * license before, he/she won't be asked again to agree. 293 * 294 * @return String 295 */ 296 public String getLicenseName() 297 { 298 return this.licenseName; 299 } //-- String getLicenseName() 300 301 /** 302 * Get dEPRECATED, use the plugin configuration instead. 303 * Location of the manifest file with NetBeans specific 304 * manifest entries. 305 * 306 * @return String 307 */ 308 public String getManifest() 309 { 310 return this.manifest; 311 } //-- String getManifest() 312 313 /** 314 * Get the modelEncoding field. 315 * 316 * @return String 317 */ 318 public String getModelEncoding() 319 { 320 return this.modelEncoding; 321 } //-- String getModelEncoding() 322 323 /** 324 * Get <p>DEPRECATED, use the plugin configuration instead. 325 * Type of the module. Possible values are </p> 326 * <p><b>autoload</b> - Such a module is 327 * automatically enabled when some other module requires it and 328 * automatically disabled otherwise.</p> 329 * <p><b>eager</b> - This module type gets 330 * automatically enabled when all it's dependencies are 331 * satisfied. Disabled otherwise.</p> 332 * <p><b>normal</b> - This is the default 333 * value. This kind of module is enabled/disabled manually by 334 * the user. It installs enabled.</p> 335 * 336 * @return String 337 */ 338 public String getModuleType() 339 { 340 return this.moduleType; 341 } //-- String getModuleType() 342 343 /** 344 * Method getNbmResources. 345 * 346 * @return List 347 */ 348 public java.util.List<NbmResource> getNbmResources() 349 { 350 if ( this.nbmResources == null ) 351 { 352 this.nbmResources = new java.util.ArrayList<NbmResource>(); 353 } 354 355 return this.nbmResources; 356 } //-- java.util.List<NbmResource> getNbmResources() 357 358 /** 359 * Get dEPRECATED, use the plugin configuration instead. 360 * Determines if the module requires restart of the 361 * IDE/platform upon installation. 362 * 363 * @return boolean 364 */ 365 public boolean isRequiresRestart() 366 { 367 return this.requiresRestart; 368 } //-- boolean isRequiresRestart() 369 370 /** 371 * Method removeDependency. 372 * 373 * @param dependency 374 */ 375 public void removeDependency( Dependency dependency ) 376 { 377 getDependencies().remove( dependency ); 378 } //-- void removeDependency( Dependency ) 379 380 /** 381 * Method removeLibrary. 382 * 383 * @param string 384 */ 385 public void removeLibrary( String string ) 386 { 387 getLibraries().remove( string ); 388 } //-- void removeLibrary( String ) 389 390 /** 391 * Method removeNbmResource. 392 * 393 * @param nbmResource 394 */ 395 public void removeNbmResource( NbmResource nbmResource ) 396 { 397 getNbmResources().remove( nbmResource ); 398 } //-- void removeNbmResource( NbmResource ) 399 400 /** 401 * Set dEPRECATED, use the plugin configuration instead. Author 402 * of the module. Is used when generating the NBM file. 403 * 404 * @param author 405 */ 406 public void setAuthor( String author ) 407 { 408 this.author = author; 409 } //-- void setAuthor( String ) 410 411 /** 412 * Set dEPRECATED, use the plugin configuration instead. Each 413 * modules should belong to a cluster. A cluster is a group of 414 * related modules. For individual modules it's not that 415 * important. Refer to netbeans.org documentation for more 416 * details. 417 * 418 * @param cluster 419 */ 420 public void setCluster( String cluster ) 421 { 422 this.cluster = cluster; 423 } //-- void setCluster( String ) 424 425 /** 426 * Set dEPRECATED, use the plugin configuration instead. 427 * Codenamebase of the module. Primary identification of the 428 * module. Usually the package name. Eg. 429 * "org.codehaus.mevenide.project". 430 * If not defined here, the default value 431 * is constructed from groupId and artifactId. 432 * 433 * @param codeNameBase 434 */ 435 public void setCodeNameBase( String codeNameBase ) 436 { 437 this.codeNameBase = codeNameBase; 438 } //-- void setCodeNameBase( String ) 439 440 /** 441 * Set dEPRECATED, use the plugin configuration instead. List 442 * of module dependencies. The plugin will use it to Generate 443 * the OpenIDE-Module-Module-Dependencies manifest entry. 444 * 445 * @param dependencies 446 */ 447 public void setDependencies( java.util.List<Dependency> dependencies ) 448 { 449 this.dependencies = dependencies; 450 } //-- void setDependencies( java.util.List ) 451 452 /** 453 * Set dEPRECATED, use the plugin configuration instead. Http 454 * URL of the location where the module can be downloaded from 455 * the internet. This value put into the NBM and used when 456 * generating the Autoupdate Site. Should point directly to the 457 * NBM download. 458 * 459 * @param distributionUrl 460 */ 461 public void setDistributionUrl( String distributionUrl ) 462 { 463 this.distributionUrl = distributionUrl; 464 } //-- void setDistributionUrl( String ) 465 466 /** 467 * Set dEPRECATED, use the plugin configuration instead. 468 * Homepage URL of the module. Is accessible from NetBeans UI 469 * upon installation, should point to place with additional 470 * information about the functionality. If not defined, it 471 * defaults to POM's url element. 472 * 473 * @param homepageUrl 474 */ 475 public void setHomepageUrl( String homepageUrl ) 476 { 477 this.homepageUrl = homepageUrl; 478 } //-- void setHomepageUrl( String ) 479 480 /** 481 * Set groupId:artifactId of artifacts that shall become part 482 * of the module and be added on the classpath 483 * (ClassPath: manifest entry gets created 484 * and the jar is included in the nbm file). 485 * 486 * @param libraries 487 */ 488 public void setLibraries( java.util.List<String> libraries ) 489 { 490 this.libraries = libraries; 491 } //-- void setLibraries( java.util.List ) 492 493 /** 494 * Set dEPRECATED, use the plugin configuration instead. Path 495 * to the license agreement file. 496 * 497 * @param licenseFile 498 */ 499 public void setLicenseFile( String licenseFile ) 500 { 501 this.licenseFile = licenseFile; 502 } //-- void setLicenseFile( String ) 503 504 /** 505 * Set dEPRECATED, use the plugin configuration instead. Name 506 * of the license. If the user already agreed to the same 507 * license before, he/she won't be asked again to agree. 508 * 509 * @param licenseName 510 */ 511 public void setLicenseName( String licenseName ) 512 { 513 this.licenseName = licenseName; 514 } //-- void setLicenseName( String ) 515 516 /** 517 * Set dEPRECATED, use the plugin configuration instead. 518 * Location of the manifest file with NetBeans specific 519 * manifest entries. 520 * 521 * @param manifest 522 */ 523 public void setManifest( String manifest ) 524 { 525 this.manifest = manifest; 526 } //-- void setManifest( String ) 527 528 /** 529 * Set the modelEncoding field. 530 * 531 * @param modelEncoding 532 */ 533 public void setModelEncoding( String modelEncoding ) 534 { 535 this.modelEncoding = modelEncoding; 536 } //-- void setModelEncoding( String ) 537 538 /** 539 * Set <p>DEPRECATED, use the plugin configuration instead. 540 * Type of the module. Possible values are </p> 541 * <p><b>autoload</b> - Such a module is 542 * automatically enabled when some other module requires it and 543 * automatically disabled otherwise.</p> 544 * <p><b>eager</b> - This module type gets 545 * automatically enabled when all it's dependencies are 546 * satisfied. Disabled otherwise.</p> 547 * <p><b>normal</b> - This is the default 548 * value. This kind of module is enabled/disabled manually by 549 * the user. It installs enabled.</p> 550 * 551 * @param moduleType 552 */ 553 public void setModuleType( String moduleType ) 554 { 555 this.moduleType = moduleType; 556 } //-- void setModuleType( String ) 557 558 /** 559 * Set dEPRECATED, use the plugin configuration instead. List 560 * of resources that shall be also included into the Nbm file 561 * along with the module jar and library jars. 562 * 563 * @param nbmResources 564 */ 565 public void setNbmResources( java.util.List<NbmResource> nbmResources ) 566 { 567 this.nbmResources = nbmResources; 568 } //-- void setNbmResources( java.util.List ) 569 570 /** 571 * Set dEPRECATED, use the plugin configuration instead. 572 * Determines if the module requires restart of the 573 * IDE/platform upon installation. 574 * 575 * @param requiresRestart 576 */ 577 public void setRequiresRestart( boolean requiresRestart ) 578 { 579 this.requiresRestart = requiresRestart; 580 } //-- void setRequiresRestart( boolean ) 581 582 }