Package org.eclipse.equinox.p2.metadata

Interface IUpdateDescriptor

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:
Restriction:
This interface is not intended to be implemented by clients.
Restriction:
This interface is not intended to be extended by clients.

  • Field Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    The description of the update.
    Collection<IMatchExpression<IInstallableUnit>>
    getIUsBeingUpdated()
    Returns an expression matching all installable units that will be updated by the unit with this update descriptor.
    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 Details

    • NORMAL

      static final int NORMAL
      Update severity constant (value 0) indicating a normal severity update.
      See Also:

    • HIGH

      static final int HIGH
      Update severity constant (value 1) indicating a high severity update.
      See Also:

  • Method Details

    • getIUsBeingUpdated

      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

      String getDescription()
      The description of the update. This allows to explain what the update is about.
      Returns:
      A description

    • getLocation

      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.