org.eclipse.equinox.p2.metadata

Interface IUpdateDescriptor

All Known Implementing Classes:

UpdateDescriptor

public interface IUpdateDescriptor

An update descriptor is attached to an installable unit to describe what that installable unit is capable of acting as an update for. Typically an installable unit will specify that it is capable of updating all installable units of the same name and with an older version. However, this descriptor allows an installable unit to be considered an update for an installable unit with a different name, or even an update for a unit with a higher version than itself.

Since:

2.0

See Also:

MetadataFactory.createUpdateDescriptor(String, VersionRange, int, String)

Field Summary

Fields

Modifier and Type	Field and Description
static int	HIGH Update severity constant (value 1) indicating a high severity update.
static int	NORMAL Update severity constant (value 0) indicating a normal severity update.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() The description of the update.
java.util.Collection<IMatchExpression<IInstallableUnit>>	getIUsBeingUpdated() Returns an expression matching all installable units that will be updated by the unit with this update descriptor.
java.net.URI	getLocation() Returns the location of a document containing the description.
int	getSeverity() The importance of the update descriptor represented as a int.
boolean	isUpdateOf(IInstallableUnit iu) Helper method indicating whether or not an installable unit is an update for the installable unit passed

Field Detail

NORMAL

static final int NORMAL

Update severity constant (value 0) indicating a normal severity update.

See Also:

Constant Field Values

HIGH

static final int HIGH

Update severity constant (value 1) indicating a high severity update.

See Also:

Constant Field Values

Method Detail

getIUsBeingUpdated

java.util.Collection<IMatchExpression<IInstallableUnit>> getIUsBeingUpdated()

Returns an expression matching all installable units that will be updated by the unit with this update descriptor.

Returns:

An expression matching all matching installable units

getDescription

java.lang.String getDescription()

The description of the update. This allows to explain what the update is about.

Returns:

A description

getLocation

java.net.URI getLocation()

Returns the location of a document containing the description.

Returns:

the location of the document, or null

getSeverity

int getSeverity()

The importance of the update descriptor represented as a int.

Returns:

The severity (either HIGH or NORMAL).

isUpdateOf

boolean isUpdateOf(IInstallableUnit iu)

Helper method indicating whether or not an installable unit is an update for the installable unit passed

Parameters:

iu - the installable unit checked

Returns:

A boolean indicating whether or not an installable unit is an update.