org.netbeans.api.autoupdate
Class UpdateElement

java.lang.Object
  org.netbeans.api.autoupdate.UpdateElement

public final class UpdateElement
extends Object

Instances provided by the UpdateUnit which represents specific version of update (e.g. module or feature). The UpdateElement can be installed, available on a remote server or stored in backup.

Method Summary

boolean	equals(Object obj)
String	getAuthor() Returns name of the author of the update element.
String	getCategory() Returns display name of category where UpdateElement belongs to.
String	getCodeName() Returns the code name of the update, sans release version.
String	getDate() Returns date when UpdateElement was published or install time if the UpdateElement is installed already.
String	getDescription() Returns the description of update, displaying in UI to end users.
String	getDisplayName() Returns the display name of the update, displaying in UI to end users.
int	getDownloadSize() Returns size of UpdateElement in Bytes.
String	getHomepage() Returns the String representation of URL.
String	getLicence() Returns text of license agreement if the UpdateElement has a copyright.
String	getNotification() Returns the special notification text of update.
String	getSource() Returns name of UpdateProvider
UpdateUnitProvider.CATEGORY	getSourceCategory() Deprecated. Use getSourceIcon() and getSourceDescription().
String	getSourceDescription() Description of the provider of this element.
Image	getSourceIcon() Provides an icon associated with the provider of this update element.
String	getSpecificationVersion() Returns the specification version.
UpdateUnit	getUpdateUnit() Returns UpdateUnit where is this UpdateElement contained.
int	hashCode()
boolean	isEnabled() Returns if the UpdateElement is active in the system.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getUpdateUnit

public UpdateUnit getUpdateUnit()

Returns UpdateUnit where is this UpdateElement contained.

Returns:

UpdateUnit in which belongs to

getCodeName

public String getCodeName()

Returns the code name of the update, sans release version.

Returns:

code name of the update

getDisplayName

public String getDisplayName()

Returns the display name of the update, displaying in UI to end users.

Returns:

display name

getSpecificationVersion

public String getSpecificationVersion()

Returns the specification version.

Returns:

specification version or null

isEnabled

public boolean isEnabled()

Returns if the UpdateElement is active in the system.

Returns:

true of UpdateElement is active

getDescription

public String getDescription()

Returns the description of update, displaying in UI to end users.

Returns:

description

getNotification

public String getNotification()

Returns the special notification text of update.

Returns:

notification text or null

getSource

public String getSource()

Returns name of UpdateProvider

Returns:

name of UpdateProvider

getSourceCategory

@Deprecated
public UpdateUnitProvider.CATEGORY getSourceCategory()

Deprecated. Use getSourceIcon() and getSourceDescription().

Returns:

UpdateUnitProvider.CATEGORY for a quality classification for update represented by this instance

getSourceIcon

public Image getSourceIcon()

Provides an icon associated with the provider of this update element.

Returns:

icon representing the provider of this element

Since:

1.23

See Also:

UpdateUnitProvider.getSourceIcon()

getSourceDescription

public String getSourceDescription()

Description of the provider of this element.

Returns:

textual description of the provider of this element

Since:

1.23

See Also:

UpdateUnitProvider.getSourceDescription()

getAuthor

public String getAuthor()

Returns name of the author of the update element.

Returns:

name or null

getHomepage

public String getHomepage()

Returns the String representation of URL.

Returns:

String or null

getDownloadSize

public int getDownloadSize()

Returns size of UpdateElement in Bytes.

Returns:

size

getCategory

public String getCategory()

Returns display name of category where UpdateElement belongs to.

Returns:

name of category

getDate

public String getDate()

Returns date when UpdateElement was published or install time if the UpdateElement is installed already. Can return null if the date is unknown.

Returns:

date in format "yyyy/MM/dd" or null

getLicence

public String getLicence()

Returns text of license agreement if the UpdateElement has a copyright.

Returns:

String or null

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object