org.eclipse.equinox.internal.p2.metadata

Class InstallableUnitPatch

java.lang.Object

org.eclipse.equinox.internal.p2.metadata.InstallableUnit

org.eclipse.equinox.internal.p2.metadata.InstallableUnitPatch

All Implemented Interfaces:

java.lang.Comparable<IInstallableUnit>, IMemberProvider, IInstallableUnit, IInstallableUnitPatch, IVersionedId

public class InstallableUnitPatch
extends InstallableUnit
implements IInstallableUnitPatch

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MEMBER_APPLICABILITY_SCOPE
static java.lang.String	MEMBER_LIFECYCLE
static java.lang.String	MEMBER_REQUIREMENTS_CHANGE

Fields inherited from class org.eclipse.equinox.internal.p2.metadata.InstallableUnit

MEMBER_ARTIFACTS, MEMBER_COPYRIGHT, MEMBER_FILTER, MEMBER_ID, MEMBER_LICENSES, MEMBER_PROFILE_PROPERTIES, MEMBER_PROPERTIES, MEMBER_PROVIDED_CAPABILITIES, MEMBER_REQUIREMENTS, MEMBER_SINGLETON, MEMBER_TOUCHPOINT_DATA, MEMBER_TOUCHPOINT_TYPE, MEMBER_TRANSLATED_PROPERTIES, MEMBER_UPDATE_DESCRIPTOR, MEMBER_VERSION

Fields inherited from interface org.eclipse.equinox.p2.metadata.IInstallableUnit

NAMESPACE_IU_ID, PROP_BUNDLE_LOCALIZATION, PROP_CONTACT, PROP_DESCRIPTION, PROP_DESCRIPTION_URL, PROP_DOC_URL, PROP_ICON, PROP_NAME, PROP_PARTIAL_IU, PROP_PROVIDER

Constructor Summary

Constructors

Constructor and Description
InstallableUnitPatch()

Method Summary

Modifier and Type	Method and Description
IRequirement[][]	getApplicabilityScope() The applicability scope of a patch describes the installable units that this patch should be applied to.
IRequirement	getLifeCycle() Returns the required capability that defines the lifecycle of this patch.
java.lang.Object	getMember(java.lang.String memberName) Returns the value for the specified member.
java.util.List<IRequirementChange>	getRequirementsChange() Returns the requirement changes imposed by the patch.
void	setApplicabilityScope(IRequirement[][] applyTo)
void	setLifeCycle(IRequirement lifeCycle)
void	setRequiredCapabilities(IRequirement[] capabilities)
void	setRequirementsChange(IRequirementChange[] changes)

Methods inherited from class org.eclipse.equinox.internal.p2.metadata.InstallableUnit

addTouchpointData, compareTo, contextIU, contextIU, equals, getArtifacts, getCopyright, getCopyright, getFilter, getFragments, getId, getLicenses, getLicenses, getLocalizedProperty, getMetaRequirements, getProperties, getProperty, getProperty, getProvidedCapabilities, getRequirements, getTouchpointData, getTouchpointType, getUpdateDescriptor, getVersion, hashCode, isResolved, isSingleton, parseFilter, satisfies, setArtifacts, setCapabilities, setCopyright, setFilter, setFilter, setId, setLicenses, setLocalizedProperty, setMetaRequiredCapabilities, setProperty, setSingleton, setTouchpointType, setUpdateDescriptor, setVersion, toString, unresolved

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.equinox.p2.metadata.IInstallableUnit

equals, getArtifacts, getCopyright, getCopyright, getFilter, getFragments, getLicenses, getLicenses, getMetaRequirements, getProperties, getProperty, getProperty, getProvidedCapabilities, getRequirements, getTouchpointData, getTouchpointType, getUpdateDescriptor, isResolved, isSingleton, satisfies, unresolved

Methods inherited from interface org.eclipse.equinox.p2.metadata.IVersionedId

getId, getVersion

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

MEMBER_APPLICABILITY_SCOPE

public static final java.lang.String MEMBER_APPLICABILITY_SCOPE

See Also:

Constant Field Values

MEMBER_LIFECYCLE

public static final java.lang.String MEMBER_LIFECYCLE

See Also:

Constant Field Values

MEMBER_REQUIREMENTS_CHANGE

public static final java.lang.String MEMBER_REQUIREMENTS_CHANGE

See Also:

Constant Field Values

Constructor Detail

InstallableUnitPatch

public InstallableUnitPatch()

Method Detail

setRequiredCapabilities

public void setRequiredCapabilities(IRequirement[] capabilities)

Overrides:

setRequiredCapabilities in class InstallableUnit

getApplicabilityScope

public IRequirement[][] getApplicabilityScope()

Description copied from interface: IInstallableUnitPatch

The applicability scope of a patch describes the installable units that this patch should be applied to. Specifically, this patch will be applied to all installable units that satisfy all of the required capabilities in one or more of the given required capability arrays.

The returned two-dimensional array can be considered as a boolean expression, where items in the inner array are connected by AND operators, and each of the arrays are separated by OR operators. For example a scope of [[r1, r2, r3], [r4, r5]] will match any unit whose provided capabilities satisfy the expression ((r1 ^ r2 ^ r3) | (r4 ^ r5)).

Specified by:

getApplicabilityScope in interface IInstallableUnitPatch

getLifeCycle

public IRequirement getLifeCycle()

Description copied from interface: IInstallableUnitPatch

Returns the required capability that defines the lifecycle of this patch. The patch will be installed into a profile if and only if the lifecycle capability is satisfied by some IU in the profile. If a future provisioning operation causes the requirement to no longer be satisfied, the patch will be uninstalled.

Specified by:

getLifeCycle in interface IInstallableUnitPatch

getRequirementsChange

public java.util.List<IRequirementChange> getRequirementsChange()

Description copied from interface: IInstallableUnitPatch

Returns the requirement changes imposed by the patch.

Specified by:

getRequirementsChange in interface IInstallableUnitPatch

Returns:

The patch requirement changes.

setApplicabilityScope

public void setApplicabilityScope(IRequirement[][] applyTo)

setLifeCycle

public void setLifeCycle(IRequirement lifeCycle)

setRequirementsChange

public void setRequirementsChange(IRequirementChange[] changes)

getMember

public java.lang.Object getMember(java.lang.String memberName)

Description copied from interface: IMemberProvider

Returns the value for the specified member. Implementers can rely on that the memberName is a string that has been internalized using String.intern().

Specified by:

getMember in interface IMemberProvider

Overrides:

getMember in class InstallableUnit

Parameters:

memberName - The name of the member

Returns:

The member value.