org.netbeans.api.autoupdate

Class UpdateUnitProviderFactory

java.lang.Object

org.netbeans.api.autoupdate.UpdateUnitProviderFactory

public final class UpdateUnitProviderFactory
extends Object

The factory handles UpdateUnitProvider, allow to create or removed them, browse the providers or refresh its content.

Method Summary

Modifier and Type	Method and Description
UpdateUnitProvider	create(String name, File... files) Creates new UpdateUnitProvider for temporary usage.
UpdateUnitProvider	create(String name, String displayName, URL url) Creates new UpdateUnitProvider and store its preferences.
UpdateUnitProvider	create(String name, String displayName, URL url, String categoryIconBase, String categoryDisplayName)
UpdateUnitProvider	create(String name, String displayName, URL url, UpdateUnitProvider.CATEGORY category) Creates new UpdateUnitProvider and store its preferences.
static UpdateUnitProviderFactory	getDefault() Returns singleton instance of UpdateUnitProviderFactory
List<UpdateUnitProvider>	getUpdateUnitProviders(boolean onlyEnabled) Returns java.util.List of UpdateUnitProvider.
void	refreshProviders(ProgressHandle handle, boolean force) Re-read list of UpdateUnitProvider from infrastucture and refresh its content if force parameter is true.
void	remove(UpdateUnitProvider unitProvider) Removes the UpdateUnitProvider from the infrastucture.

Methods inherited from class java.lang.Object

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

Method Detail

getDefault

public static UpdateUnitProviderFactory getDefault()

Returns singleton instance of UpdateUnitProviderFactory

Returns:

UpdateUnitProviderFactory singleton instance of UpdateUnitProviderFactory

getUpdateUnitProviders

public List<UpdateUnitProvider> getUpdateUnitProviders(boolean onlyEnabled)

Returns java.util.List of UpdateUnitProvider. The parameter onlyEnabled specifies if only enabled provider should be returned or all.

Parameters:

onlyEnabled - if only enabled provider should be returned or all

Returns:

list of providers

create

public UpdateUnitProvider create(String name,
                                 String displayName,
                                 URL url,
                                 UpdateUnitProvider.CATEGORY category)

Creates new UpdateUnitProvider and store its preferences. The new provider is based of the given URL where is the Autoupdate Catalog.

Parameters:

name - name of provider, this name is used by Autoupdate infrastructure for manimulating of providers.

displayName - display name of provider

url - URL to Autoupdate Catalog

category - quality classification for every UpdateElement comming from returned UpdateUnitProvider

Returns:

URL-based UpdateUnitProvider

create

public UpdateUnitProvider create(String name,
                                 String displayName,
                                 URL url,
                                 String categoryIconBase,
                                 String categoryDisplayName)

Since:

1.23

create

public UpdateUnitProvider create(String name,
                                 String displayName,
                                 URL url)

Creates new UpdateUnitProvider and store its preferences. The new provider is based of the given URL where is the Autoupdate Catalog.

Parameters:

name - name of provider, this name is used by Autoupdate infrastructure for manimulating of providers.

displayName - display name of provider

url - URL to Autoupdate Catalog

Returns:

URL-based UpdateUnitProvider

create

public UpdateUnitProvider create(String name,
                                 File... files)

Creates new UpdateUnitProvider for temporary usage. This provider contains content of given NBMs.

Parameters:

name - name of provider, this name is used by Autoupdate infrastructure for manimulating of providers.

files - NBM files

Returns:

UpdateUnitProvider

remove

public void remove(UpdateUnitProvider unitProvider)

Removes the UpdateUnitProvider from the infrastucture.

Parameters:

unitProvider -

refreshProviders

public void refreshProviders(ProgressHandle handle,
                             boolean force)
                      throws IOException

Re-read list of UpdateUnitProvider from infrastucture and refresh its content if force parameter is true.

Parameters:

handle - started ProgressHandle or null

force - if true then refresh(true) is called on all UpdateUnitProvider

Throws:

IOException