org.codehaus.mojo.nbm.model.NetBeansModule Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of nbm-maven-plugin Show documentation
Show all versions of nbm-maven-plugin Show documentation
Maven plugin for creating NetBeans modules. It defines a custom lifecycle called "nbm". During packaging, the module JAR is enhanced with NetBeans-specific manifest entries and, along with other required files, packed into a *.nbm file, ready for distribution. Additionally the plugin provides aggregator goals to create an update site or cluster for your module projects.
/*
=================== DO NOT EDIT THIS FILE ====================
Generated by Modello 1.5 on 2013-09-11 17:40:33,
any modifications will be overwritten.
==============================================================
*/
package org.codehaus.mojo.nbm.model;
/**
* Describes the layout, dependencies and packaging of a NetBeans
* module.
*
* @version $Revision$ $Date$
*/
@SuppressWarnings( "all" )
public class NetBeansModule
implements java.io.Serializable
{
//--------------------------/
//- Class/Member Variables -/
//--------------------------/
/**
*
* DEPRECATED, use the plugin
* configuration instead. Type of the module. Possible values
* are
* autoload - Such a module is
* automatically enabled when some other module requires it and
* automatically disabled otherwise.
* eager - This module type gets
* automatically enabled when all it's dependencies are
* satisfied. Disabled otherwise.
* normal - This is the default
* value. This kind of module is enabled/disabled manually by
* the user. It installs enabled.
*
*/
@Deprecated
private String moduleType;
/**
* DEPRECATED, use the plugin configuration instead.
* Codenamebase of the module. Primary identification of the
* module. Usually the package name. Eg.
* "org.codehaus.mevenide.project".
* If not defined here, the default value
* is constructed from groupId and artifactId.
*/
@Deprecated
private String codeNameBase;
/**
* DEPRECATED, use the plugin configuration instead. Each
* modules should belong to a cluster. A cluster is a group of
* related modules. For individual modules it's not that
* important. Refer to netbeans.org documentation for more
* details.
*/
@Deprecated
private String cluster;
/**
* DEPRECATED, use the plugin configuration instead. Determines
* if the module requires restart of the IDE/platform upon
* installation.
*/
@Deprecated
private boolean requiresRestart = false;
/**
* DEPRECATED, use the plugin configuration instead. Location
* of the manifest file with NetBeans specific manifest
* entries.
*
*/
@Deprecated
private String manifest;
/**
* DEPRECATED, use the plugin configuration instead. Homepage
* URL of the module. Is accessible from NetBeans UI upon
* installation, should point to place with additional
* information about the functionality. If not defined, it
* defaults to POM's url element.
*/
@Deprecated
private String homepageUrl;
/**
* DEPRECATED, use the plugin configuration instead. Http URL
* of the location where the module can be downloaded from the
* internet. This value put into the NBM and used when
* generating the Autoupdate Site. Should point directly to the
* NBM download.
*/
@Deprecated
private String distributionUrl;
/**
* DEPRECATED, use the plugin configuration instead. Author of
* the module. Is used when generating the NBM file.
*/
@Deprecated
private String author;
/**
* DEPRECATED, use the plugin configuration instead. Name of
* the license. If the user already agreed to the same license
* before, he/she won't be asked again to agree.
*/
@Deprecated
private String licenseName;
/**
* DEPRECATED, use the plugin configuration instead. Path to
* the license agreement file.
*/
@Deprecated
private String licenseFile;
/**
* Field libraries.
*/
private java.util.List libraries;
/**
* Field dependencies.
*/
private java.util.List dependencies;
/**
* Field nbmResources.
*/
@Deprecated
private java.util.List nbmResources;
/**
* Field modelEncoding.
*/
private String modelEncoding = "UTF-8";
//-----------/
//- Methods -/
//-----------/
/**
* Method addDependency.
*
* @param dependency
*/
public void addDependency( Dependency dependency )
{
getDependencies().add( dependency );
} //-- void addDependency( Dependency )
/**
* Method addLibrary.
*
* @param string
*/
public void addLibrary( String string )
{
getLibraries().add( string );
} //-- void addLibrary( String )
/**
* Method addNbmResource.
*
* @param nbmResource
*/
public void addNbmResource( NbmResource nbmResource )
{
getNbmResources().add( nbmResource );
} //-- void addNbmResource( NbmResource )
/**
* Get dEPRECATED, use the plugin configuration instead. Author
* of the module. Is used when generating the NBM file.
*
* @return String
*/
public String getAuthor()
{
return this.author;
} //-- String getAuthor()
/**
* Get dEPRECATED, use the plugin configuration instead. Each
* modules should belong to a cluster. A cluster is a group of
* related modules. For individual modules it's not that
* important. Refer to netbeans.org documentation for more
* details.
*
* @return String
*/
public String getCluster()
{
return this.cluster;
} //-- String getCluster()
/**
* Get dEPRECATED, use the plugin configuration instead.
* Codenamebase of the module. Primary identification of the
* module. Usually the package name. Eg.
* "org.codehaus.mevenide.project".
* If not defined here, the default value
* is constructed from groupId and artifactId.
*
* @return String
*/
public String getCodeNameBase()
{
return this.codeNameBase;
} //-- String getCodeNameBase()
/**
* Method getDependencies.
*
* @return List
*/
public java.util.List getDependencies()
{
if ( this.dependencies == null )
{
this.dependencies = new java.util.ArrayList();
}
return this.dependencies;
} //-- java.util.List getDependencies()
/**
* Get dEPRECATED, use the plugin configuration instead. Http
* URL of the location where the module can be downloaded from
* the internet. This value put into the NBM and used when
* generating the Autoupdate Site. Should point directly to the
* NBM download.
*
* @return String
*/
public String getDistributionUrl()
{
return this.distributionUrl;
} //-- String getDistributionUrl()
/**
* Get dEPRECATED, use the plugin configuration instead.
* Homepage URL of the module. Is accessible from NetBeans UI
* upon installation, should point to place with additional
* information about the functionality. If not defined, it
* defaults to POM's url element.
*
* @return String
*/
public String getHomepageUrl()
{
return this.homepageUrl;
} //-- String getHomepageUrl()
/**
* Method getLibraries.
*
* @return List
*/
public java.util.List getLibraries()
{
if ( this.libraries == null )
{
this.libraries = new java.util.ArrayList();
}
return this.libraries;
} //-- java.util.List getLibraries()
/**
* Get dEPRECATED, use the plugin configuration instead. Path
* to the license agreement file.
*
* @return String
*/
public String getLicenseFile()
{
return this.licenseFile;
} //-- String getLicenseFile()
/**
* Get dEPRECATED, use the plugin configuration instead. Name
* of the license. If the user already agreed to the same
* license before, he/she won't be asked again to agree.
*
* @return String
*/
public String getLicenseName()
{
return this.licenseName;
} //-- String getLicenseName()
/**
* Get dEPRECATED, use the plugin configuration instead.
* Location of the manifest file with NetBeans specific
* manifest entries.
*
* @return String
*/
public String getManifest()
{
return this.manifest;
} //-- String getManifest()
/**
* Get the modelEncoding field.
*
* @return String
*/
public String getModelEncoding()
{
return this.modelEncoding;
} //-- String getModelEncoding()
/**
* Get DEPRECATED, use the plugin configuration instead.
* Type of the module. Possible values are
* autoload - Such a module is
* automatically enabled when some other module requires it and
* automatically disabled otherwise.
* eager - This module type gets
* automatically enabled when all it's dependencies are
* satisfied. Disabled otherwise.
* normal - This is the default
* value. This kind of module is enabled/disabled manually by
* the user. It installs enabled.
*
* @return String
*/
public String getModuleType()
{
return this.moduleType;
} //-- String getModuleType()
/**
* Method getNbmResources.
*
* @return List
*/
public java.util.List getNbmResources()
{
if ( this.nbmResources == null )
{
this.nbmResources = new java.util.ArrayList();
}
return this.nbmResources;
} //-- java.util.List getNbmResources()
/**
* Get dEPRECATED, use the plugin configuration instead.
* Determines if the module requires restart of the
* IDE/platform upon installation.
*
* @return boolean
*/
public boolean isRequiresRestart()
{
return this.requiresRestart;
} //-- boolean isRequiresRestart()
/**
* Method removeDependency.
*
* @param dependency
*/
public void removeDependency( Dependency dependency )
{
getDependencies().remove( dependency );
} //-- void removeDependency( Dependency )
/**
* Method removeLibrary.
*
* @param string
*/
public void removeLibrary( String string )
{
getLibraries().remove( string );
} //-- void removeLibrary( String )
/**
* Method removeNbmResource.
*
* @param nbmResource
*/
public void removeNbmResource( NbmResource nbmResource )
{
getNbmResources().remove( nbmResource );
} //-- void removeNbmResource( NbmResource )
/**
* Set dEPRECATED, use the plugin configuration instead. Author
* of the module. Is used when generating the NBM file.
*
* @param author
*/
public void setAuthor( String author )
{
this.author = author;
} //-- void setAuthor( String )
/**
* Set dEPRECATED, use the plugin configuration instead. Each
* modules should belong to a cluster. A cluster is a group of
* related modules. For individual modules it's not that
* important. Refer to netbeans.org documentation for more
* details.
*
* @param cluster
*/
public void setCluster( String cluster )
{
this.cluster = cluster;
} //-- void setCluster( String )
/**
* Set dEPRECATED, use the plugin configuration instead.
* Codenamebase of the module. Primary identification of the
* module. Usually the package name. Eg.
* "org.codehaus.mevenide.project".
* If not defined here, the default value
* is constructed from groupId and artifactId.
*
* @param codeNameBase
*/
public void setCodeNameBase( String codeNameBase )
{
this.codeNameBase = codeNameBase;
} //-- void setCodeNameBase( String )
/**
* Set dEPRECATED, use the plugin configuration instead. List
* of module dependencies. The plugin will use it to Generate
* the OpenIDE-Module-Module-Dependencies manifest entry.
*
* @param dependencies
*/
public void setDependencies( java.util.List dependencies )
{
this.dependencies = dependencies;
} //-- void setDependencies( java.util.List )
/**
* Set dEPRECATED, use the plugin configuration instead. Http
* URL of the location where the module can be downloaded from
* the internet. This value put into the NBM and used when
* generating the Autoupdate Site. Should point directly to the
* NBM download.
*
* @param distributionUrl
*/
public void setDistributionUrl( String distributionUrl )
{
this.distributionUrl = distributionUrl;
} //-- void setDistributionUrl( String )
/**
* Set dEPRECATED, use the plugin configuration instead.
* Homepage URL of the module. Is accessible from NetBeans UI
* upon installation, should point to place with additional
* information about the functionality. If not defined, it
* defaults to POM's url element.
*
* @param homepageUrl
*/
public void setHomepageUrl( String homepageUrl )
{
this.homepageUrl = homepageUrl;
} //-- void setHomepageUrl( String )
/**
* Set groupId:artifactId of artifacts that shall become part
* of the module and be added on the classpath
* (ClassPath: manifest entry gets created
* and the jar is included in the nbm file).
*
* @param libraries
*/
public void setLibraries( java.util.List libraries )
{
this.libraries = libraries;
} //-- void setLibraries( java.util.List )
/**
* Set dEPRECATED, use the plugin configuration instead. Path
* to the license agreement file.
*
* @param licenseFile
*/
public void setLicenseFile( String licenseFile )
{
this.licenseFile = licenseFile;
} //-- void setLicenseFile( String )
/**
* Set dEPRECATED, use the plugin configuration instead. Name
* of the license. If the user already agreed to the same
* license before, he/she won't be asked again to agree.
*
* @param licenseName
*/
public void setLicenseName( String licenseName )
{
this.licenseName = licenseName;
} //-- void setLicenseName( String )
/**
* Set dEPRECATED, use the plugin configuration instead.
* Location of the manifest file with NetBeans specific
* manifest entries.
*
* @param manifest
*/
public void setManifest( String manifest )
{
this.manifest = manifest;
} //-- void setManifest( String )
/**
* Set the modelEncoding field.
*
* @param modelEncoding
*/
public void setModelEncoding( String modelEncoding )
{
this.modelEncoding = modelEncoding;
} //-- void setModelEncoding( String )
/**
* Set DEPRECATED, use the plugin configuration instead.
* Type of the module. Possible values are
* autoload - Such a module is
* automatically enabled when some other module requires it and
* automatically disabled otherwise.
* eager - This module type gets
* automatically enabled when all it's dependencies are
* satisfied. Disabled otherwise.
* normal - This is the default
* value. This kind of module is enabled/disabled manually by
* the user. It installs enabled.
*
* @param moduleType
*/
public void setModuleType( String moduleType )
{
this.moduleType = moduleType;
} //-- void setModuleType( String )
/**
* Set dEPRECATED, use the plugin configuration instead. List
* of resources that shall be also included into the Nbm file
* along with the module jar and library jars.
*
* @param nbmResources
*/
public void setNbmResources( java.util.List nbmResources )
{
this.nbmResources = nbmResources;
} //-- void setNbmResources( java.util.List )
/**
* Set dEPRECATED, use the plugin configuration instead.
* Determines if the module requires restart of the
* IDE/platform upon installation.
*
* @param requiresRestart
*/
public void setRequiresRestart( boolean requiresRestart )
{
this.requiresRestart = requiresRestart;
} //-- void setRequiresRestart( boolean )
}