org.netbeans.spi.autoupdate

Class UpdateItem

java.lang.Object

org.netbeans.spi.autoupdate.UpdateItem

public final class UpdateItem
extends Object

Represents a item of content provider by UpdateProvider. These items are exposed to Autoupdate infrastructure what works on them.

Method Summary

Modifier and Type	Method and Description
static UpdateItem	createFeature(String codeName, String specificationVersion, Set<String> dependencies, String displayName, String description, String category) Creates UpdateItem which represents Feature, it's means group of NetBeans Modules.
static UpdateItem	createInstalledNativeComponent(String codeName, String specificationVersion, Set<String> dependencies, String displayName, String description, CustomUninstaller uninstaller) Creates UpdateItem which represents Native Component with own installer.
static UpdateItem	createLocalization(String codeName, String specificationVersion, String moduleSpecificationVersion, Locale locale, String branding, String localizedName, String localizedDescription, String category, URL distribution, Boolean needsRestart, Boolean isGlobal, String targetCluster, UpdateLicense license) Creates UpdateItem which can localized NetBeans Module in given Locale.
static UpdateItem	createModule(String codeName, String specificationVersion, URL distribution, String author, String downloadSize, String homepage, String publishDate, String category, Manifest manifest, Boolean isEager, Boolean isAutoload, Boolean needsRestart, Boolean isGlobal, Boolean isPreferedUpdate, String targetCluster, UpdateLicense license) Creates UpdateItem/code> which represents NetBeans Module in Autoupdate infrastructure.
static UpdateItem	createModule(String codeName, String specificationVersion, URL distribution, String author, String downloadSize, String homepage, String publishDate, String category, Manifest manifest, Boolean isEager, Boolean isAutoload, Boolean needsRestart, Boolean isGlobal, String targetCluster, UpdateLicense license) Creates UpdateItem/code> which represents NetBeans Module in Autoupdate infrastructure.
static UpdateItem	createNativeComponent(String codeName, String specificationVersion, String downloadSize, Set<String> dependencies, String displayName, String description, Boolean needsRestart, Boolean isGlobal, String targetCluster, CustomInstaller installer, UpdateLicense license) Creates UpdateItem which represents Native Component with own installer.

Methods inherited from class java.lang.Object

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

Method Detail

createModule

public static UpdateItem createModule(String codeName,
                                      String specificationVersion,
                                      URL distribution,
                                      String author,
                                      String downloadSize,
                                      String homepage,
                                      String publishDate,
                                      String category,
                                      Manifest manifest,
                                      Boolean isEager,
                                      Boolean isAutoload,
                                      Boolean needsRestart,
                                      Boolean isGlobal,
                                      String targetCluster,
                                      UpdateLicense license)

Creates UpdateItem/code> which represents NetBeans Module in Autoupdate infrastructure. UpdateItem is identify by codeName and specificationVersion.

Parameters:

codeName - code name of module

specificationVersion - specification version of module

distribution - URL to NBM file

author - name of module author or null

downloadSize - size of NBM file in bytes

homepage - homepage of module or null

publishDate - date of publish of item, in date format "yyyy/MM/dd"

category - name of category

manifest - java.util.jar.Manifest describes the module in NetBeans module system

isEager - says if the module is eager or not

isAutoload - says if the module is autoload or not

needsRestart - if true then IDE must be restarted after module installation

isGlobal - control if the module will be installed into the installation directory or into user's dir

targetCluster - name of cluster where new module will be installed if installation isGlobal

license - UpdateLicense represents license name and text of license agreement

Returns:

UpdateItem

createModule

public static UpdateItem createModule(String codeName,
                                      String specificationVersion,
                                      URL distribution,
                                      String author,
                                      String downloadSize,
                                      String homepage,
                                      String publishDate,
                                      String category,
                                      Manifest manifest,
                                      Boolean isEager,
                                      Boolean isAutoload,
                                      Boolean needsRestart,
                                      Boolean isGlobal,
                                      Boolean isPreferedUpdate,
                                      String targetCluster,
                                      UpdateLicense license)

Creates UpdateItem/code> which represents NetBeans Module in Autoupdate infrastructure. UpdateItem is identify by codeName and specificationVersion.

Parameters:

codeName - code name of module

specificationVersion - specification version of module

distribution - URL to NBM file

author - name of module author or null

downloadSize - size of NBM file in bytes

homepage - homepage of module or null

publishDate - date of publish of item, in date format "yyyy/MM/dd"

category - name of category

manifest - java.util.jar.Manifest describes the module in NetBeans module system

isEager - says if the module is eager or not

isAutoload - says if the module is autoload or not

needsRestart - if true then IDE must be restarted after module installation

isGlobal - control if the module will be installed into the installation directory or into user's dir

isPreferedUpdate - if true will be handled in exclusive mode before other updates

targetCluster - name of cluster where new module will be installed if installation isGlobal

license - UpdateLicense represents license name and text of license agreement

Returns:

UpdateItem

Since:

1.33

createFeature

public static UpdateItem createFeature(String codeName,
                                       String specificationVersion,
                                       Set<String> dependencies,
                                       String displayName,
                                       String description,
                                       String category)

Creates UpdateItem which represents Feature, it's means group of NetBeans Modules. This Feature is handled in UI as atomic item. UpdateItem is identify by codeName and specificationVersion.

If some of the tokens in dependencies is not known, it will be reported as a missing dependency.

Parameters:

codeName - code name of feature

specificationVersion - specification version of feature

dependencies - dependencies to NetBeans modules on which is the feature based

displayName - display name

description - description

category - name of category

Returns:

UpdateItem

Since:

1.57 specified handling of unknown tokens

createNativeComponent

public static UpdateItem createNativeComponent(String codeName,
                                               String specificationVersion,
                                               String downloadSize,
                                               Set<String> dependencies,
                                               String displayName,
                                               String description,
                                               Boolean needsRestart,
                                               Boolean isGlobal,
                                               String targetCluster,
                                               CustomInstaller installer,
                                               UpdateLicense license)

Creates UpdateItem which represents Native Component with own installer. This component can be visualized in UI as common item, when an user wants to install this component then own CustomInstaller is call back.

Parameters:

codeName - code name of the native component

specificationVersion - specification version of component

dependencies - dependencies to other UpdateItem

downloadSize - size of installation file in bytes

displayName - display name

description - description

needsRestart - if true then IDE must be restarted after component installation

isGlobal - control if the control will be installed into the installation directory or into user's dir

targetCluster - name of cluster where new module will be installed if installation isGlobal

installer - CustomInstaller call-back interface

license - UpdateLicense represents license name and text of license agreement

Returns:

UpdateItem

createInstalledNativeComponent

public static UpdateItem createInstalledNativeComponent(String codeName,
                                                        String specificationVersion,
                                                        Set<String> dependencies,
                                                        String displayName,
                                                        String description,
                                                        CustomUninstaller uninstaller)

Creates UpdateItem which represents Native Component with own installer. This component can be visualized in UI as common item, when an user wants to install this component then own CustomInstaller is called back.

Parameters:

codeName - code name of the native component

specificationVersion - specification version of component

dependencies - dependencies to other UpdateItem

displayName - display name

description - description

uninstaller - CustomUninstaller call-back interface

Returns:

UpdateItem

createLocalization

public static UpdateItem createLocalization(String codeName,
                                            String specificationVersion,
                                            String moduleSpecificationVersion,
                                            Locale locale,
                                            String branding,
                                            String localizedName,
                                            String localizedDescription,
                                            String category,
                                            URL distribution,
                                            Boolean needsRestart,
                                            Boolean isGlobal,
                                            String targetCluster,
                                            UpdateLicense license)

Creates UpdateItem which can localized NetBeans Module in given Locale.

Parameters:

codeName - code name of the module for localization

specificationVersion - specification version of localization

moduleSpecificationVersion - specification version of the module for localization

locale - locale

branding - branding

localizedName - localized name of module

localizedDescription - localized descripton of module

category - name of category

distribution - URL to NBM file

needsRestart - if true then IDE must be restarted after module installation

isGlobal - control if the module will be installed into the installation directory or into user's dir

targetCluster - name of cluster where new module will be installed if installation isGlobal

license - UpdateLicense represents license name and text of license agreement

Returns:

UpdateItem