org.codehaus.mojo.nbm.model

Class NetBeansModule

java.lang.Object

org.codehaus.mojo.nbm.model.NetBeansModule

All Implemented Interfaces:

Serializable

public class NetBeansModule
extends Object
implements Serializable

Describes the layout, dependencies and packaging of a NetBeans module.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NetBeansModule()

Method Summary

Methods

Modifier and Type	Method and Description
void	addDependency(Dependency dependency) Method addDependency.
void	addLibrary(String string) Method addLibrary.
void	addNbmResource(NbmResource nbmResource) Method addNbmResource.
String	getAuthor() Get dEPRECATED, use the plugin configuration instead.
String	getCluster() Get dEPRECATED, use the plugin configuration instead.
String	getCodeNameBase() Get dEPRECATED, use the plugin configuration instead.
List<Dependency>	getDependencies() Method getDependencies.
String	getDistributionUrl() Get dEPRECATED, use the plugin configuration instead.
String	getHomepageUrl() Get dEPRECATED, use the plugin configuration instead.
List<String>	getLibraries() Method getLibraries.
String	getLicenseFile() Get dEPRECATED, use the plugin configuration instead.
String	getLicenseName() Get dEPRECATED, use the plugin configuration instead.
String	getManifest() Get dEPRECATED, use the plugin configuration instead.
String	getModelEncoding() Get the modelEncoding field.
String	getModuleType() Get
List<NbmResource>	getNbmResources() Method getNbmResources.
boolean	isRequiresRestart() Get dEPRECATED, use the plugin configuration instead.
void	removeDependency(Dependency dependency) Method removeDependency.
void	removeLibrary(String string) Method removeLibrary.
void	removeNbmResource(NbmResource nbmResource) Method removeNbmResource.
void	setAuthor(String author) Set dEPRECATED, use the plugin configuration instead.
void	setCluster(String cluster) Set dEPRECATED, use the plugin configuration instead.
void	setCodeNameBase(String codeNameBase) Set dEPRECATED, use the plugin configuration instead.
void	setDependencies(List<Dependency> dependencies) Set dEPRECATED, use the plugin configuration instead.
void	setDistributionUrl(String distributionUrl) Set dEPRECATED, use the plugin configuration instead.
void	setHomepageUrl(String homepageUrl) Set dEPRECATED, use the plugin configuration instead.
void	setLibraries(List<String> libraries) 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).
void	setLicenseFile(String licenseFile) Set dEPRECATED, use the plugin configuration instead.
void	setLicenseName(String licenseName) Set dEPRECATED, use the plugin configuration instead.
void	setManifest(String manifest) Set dEPRECATED, use the plugin configuration instead.
void	setModelEncoding(String modelEncoding) Set the modelEncoding field.
void	setModuleType(String moduleType) Set
void	setNbmResources(List<NbmResource> nbmResources) Set dEPRECATED, use the plugin configuration instead.
void	setRequiresRestart(boolean requiresRestart) Set dEPRECATED, use the plugin configuration instead.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NetBeansModule

public NetBeansModule()

Method Detail

addDependency

public void addDependency(Dependency dependency)

Method addDependency.

Parameters:

dependency -

addLibrary

public void addLibrary(String string)

Method addLibrary.

Parameters:

string -

addNbmResource

public void addNbmResource(NbmResource nbmResource)

Method addNbmResource.

Parameters:

nbmResource -

getAuthor

public String getAuthor()

Get dEPRECATED, use the plugin configuration instead. Author of the module. Is used when generating the NBM file.

Returns:

String

getCluster

public String getCluster()

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.

Returns:

String

getCodeNameBase

public String getCodeNameBase()

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.

Returns:

String

getDependencies

public List<Dependency> getDependencies()

Method getDependencies.

Returns:

List

getDistributionUrl

public String getDistributionUrl()

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.

Returns:

String

getHomepageUrl

public String getHomepageUrl()

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.

Returns:

String

getLibraries

public List<String> getLibraries()

Method getLibraries.

Returns:

List

getLicenseFile

public String getLicenseFile()

Get dEPRECATED, use the plugin configuration instead. Path to the license agreement file.

Returns:

String

getLicenseName

public String getLicenseName()

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.

Returns:

String

getManifest

public String getManifest()

Get dEPRECATED, use the plugin configuration instead. Location of the manifest file with NetBeans specific manifest entries.

Returns:

String

getModelEncoding

public String getModelEncoding()

Get the modelEncoding field.

Returns:

String

getModuleType

public String getModuleType()

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.

Returns:

String

getNbmResources

public List<NbmResource> getNbmResources()

Method getNbmResources.

Returns:

List

isRequiresRestart

public boolean isRequiresRestart()

Get dEPRECATED, use the plugin configuration instead. Determines if the module requires restart of the IDE/platform upon installation.

Returns:

boolean

removeDependency

public void removeDependency(Dependency dependency)

Method removeDependency.

Parameters:

dependency -

removeLibrary

public void removeLibrary(String string)

Method removeLibrary.

Parameters:

string -

removeNbmResource

public void removeNbmResource(NbmResource nbmResource)

Method removeNbmResource.

Parameters:

nbmResource -

setAuthor

public void setAuthor(String author)

Set dEPRECATED, use the plugin configuration instead. Author of the module. Is used when generating the NBM file.

Parameters:

author -

setCluster

public void setCluster(String cluster)

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.

Parameters:

cluster -

setCodeNameBase

public void setCodeNameBase(String codeNameBase)

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.

Parameters:

codeNameBase -

setDependencies

public void setDependencies(List<Dependency> dependencies)

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.

Parameters:

dependencies -

setDistributionUrl

public void setDistributionUrl(String distributionUrl)

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.

Parameters:

distributionUrl -

setHomepageUrl

public void setHomepageUrl(String homepageUrl)

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.

Parameters:

homepageUrl -

setLibraries

public void setLibraries(List<String> libraries)

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).

Parameters:

libraries -

setLicenseFile

public void setLicenseFile(String licenseFile)

Set dEPRECATED, use the plugin configuration instead. Path to the license agreement file.

Parameters:

licenseFile -

setLicenseName

public void setLicenseName(String licenseName)

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.

Parameters:

licenseName -

setManifest

public void setManifest(String manifest)

Set dEPRECATED, use the plugin configuration instead. Location of the manifest file with NetBeans specific manifest entries.

Parameters:

manifest -

setModelEncoding

public void setModelEncoding(String modelEncoding)

Set the modelEncoding field.

Parameters:

modelEncoding -

setModuleType

public void setModuleType(String moduleType)

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.

Parameters:

moduleType -

setNbmResources

public void setNbmResources(List<NbmResource> nbmResources)

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.

Parameters:

nbmResources -

setRequiresRestart

public void setRequiresRestart(boolean requiresRestart)

Set dEPRECATED, use the plugin configuration instead. Determines if the module requires restart of the IDE/platform upon installation.

Parameters:

requiresRestart -