Method Detail

• getName

  public java.lang.String getName​()

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

  Returns:

  name of provider

• getDisplayName

  public java.lang.String getDisplayName​()

  Display name of provider. This display name can be visualized in UI.

  Returns:

  display name of provider

• setDisplayName

  public void setDisplayName​(java.lang.String name)

  Sets the display name of the provider. This name can be presented to users in UI.

  Parameters:

  name -

• getDescription

  public java.lang.String getDescription​()

  Description of provider. This description can be visualized in UI.

  Returns:

  description of provider or null

• getCategory

  @Deprecated
  public UpdateUnitProvider.CATEGORY getCategory​()

  Deprecated. Use getSourceIcon() and getSourceDescription().

• getSourceIcon

  public java.awt.Image getSourceIcon​()

  The icon associated with this provider. In case no specific icon is associated, a general one is returned.

  Since:

  1.23

  See Also:

  UpdateElement.getSourceIcon()

• getSourceDescription

  public java.lang.String getSourceDescription​()

  The description of this provider. Usually associated with getSourceIcon(). In case no special description is found, a general one is returned.

  Returns:

  textual description of the provider

  Since:

  1.23

  See Also:

  UpdateElement.getSourceDescription()

• getContentDescription

  public java.lang.String getContentDescription​()

  A description of content staging by this provider. The description might contains HTML tags e.g. HTML Links.

  Returns:

  textual description of content or null

  Since:

  1.33

• getProviderURL

  public java.net.URL getProviderURL​()

  It's special support for UpdateProvider based on Autoupdate Catalog. It's most kind of Update Providers and have a special support in UI.

  Returns:

  URL of provider URL or null if and only if the UpdateProvider doesn't based of Autoupdate Catalog

• setProviderURL

  public void setProviderURL​(java.net.URL url)

  Modified URL of URL-based provider. If the UpdateProvider doesn't support URL then the method has no affect.

  Parameters:

  url - new URL

• getUpdateUnits

  public java.util.List<UpdateUnit> getUpdateUnits​()

  Returns java.util.List of UpdateUnit build of the content of the provider.

  Returns:

  list of UpdateUnit

• getUpdateUnits

  public java.util.List<UpdateUnit> getUpdateUnits​(UpdateManager.TYPE... types)

  Returns java.util.List of UpdateUnit build of the content of the provider.

  Parameters:

  types - returns UpdateUnits contain only given types, e.g. modules for MODULE type. If types is null or null then returns default types

  Returns:

  list of UpdateUnit

• refresh

  public boolean refresh​(org.netbeans.api.progress.ProgressHandle handle,
                         boolean force)
                  throws java.io.IOException

  Make refresh of content of the provider. The content can be read from a cache. The force parameter forces reading content from remote server.

  Parameters:

  handle - started ProgressHandle or null

  force - if true then forces to reread the content from server

  Returns:

  true if refresh succeed

  Throws:

  java.io.IOException - when any network problem appreared

• isEnabled

  public boolean isEnabled​()

  Returns true if the provider is automatically checked and its UpdateUnit are returned from UpdateManager

  Returns:

  enable flag

• setEnable

  public void setEnable​(boolean state)

  Sets the enable flag.

  Parameters:

  state -

  See Also:

  isEnabled()

• toString

  public java.lang.String toString​()

  Overrides:

  toString in class java.lang.Object