org.eclipse.equinox.internal.p2.metadata

Class InstallableUnit

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

InstallableUnitFragment, InstallableUnitPatch

public class InstallableUnit
extends java.lang.Object
implements IInstallableUnit, IMemberProvider

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MEMBER_ARTIFACTS
static java.lang.String	MEMBER_COPYRIGHT
static java.lang.String	MEMBER_FILTER
static java.lang.String	MEMBER_ID
static java.lang.String	MEMBER_LICENSES
static java.lang.String	MEMBER_PROFILE_PROPERTIES
static java.lang.String	MEMBER_PROPERTIES
static java.lang.String	MEMBER_PROVIDED_CAPABILITIES
static java.lang.String	MEMBER_REQUIREMENTS
static java.lang.String	MEMBER_SINGLETON
static java.lang.String	MEMBER_TOUCHPOINT_DATA
static java.lang.String	MEMBER_TOUCHPOINT_TYPE
static java.lang.String	MEMBER_TRANSLATED_PROPERTIES
static java.lang.String	MEMBER_UPDATE_DESCRIPTOR
static java.lang.String	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
InstallableUnit()

Method Summary

Modifier and Type	Method and Description
void	addTouchpointData(ITouchpointData newData)
int	compareTo(IInstallableUnit other)
static IInstallableUnit	contextIU(java.util.Map<java.lang.String,java.lang.String> environment)
static IInstallableUnit	contextIU(java.lang.String ws, java.lang.String os, java.lang.String arch)
boolean	equals(java.lang.Object obj) Returns whether this InstallableUnit is equal to the given object.
java.util.Collection<IArtifactKey>	getArtifacts() Returns the collection of artifacts associated with this installable unit.
ICopyright	getCopyright() Returns the untranslated copyright that applies to this installable unit.
ICopyright	getCopyright(java.lang.String locale) Returns the copyright that applies to this installable unit.
IMatchExpression<IInstallableUnit>	getFilter() Returns the filter on this installable unit.
java.util.Collection<IInstallableUnitFragment>	getFragments() Returns the fragments that have been bound to this installable unit, or null if this unit is not resolved.
java.lang.String	getId() Returns the id portion of this versioned id.
java.util.Collection<ILicense>	getLicenses() Returns the untranslated licenses that apply to this installable unit.
java.util.Collection<ILicense>	getLicenses(java.lang.String locale) Returns the licenses that apply to this installable unit.
java.lang.String	getLocalizedProperty(java.lang.String key)
java.lang.Object	getMember(java.lang.String memberName) Returns the value for the specified member.
java.util.Collection<IRequirement>	getMetaRequirements()
java.util.Map<java.lang.String,java.lang.String>	getProperties() Get an unmodifiable copy of the properties associated with the installable unit.
java.lang.String	getProperty(java.lang.String key) Returns the untranslated property of this installable unit associated with the given key.
java.lang.String	getProperty(java.lang.String key, java.lang.String locale) Returns the property of this installable unit associated with the given key.
java.util.Collection<IProvidedCapability>	getProvidedCapabilities() Returns the collection of capabilities provided by this installable unit.
java.util.List<IRequirement>	getRequirements()
java.util.Collection<ITouchpointData>	getTouchpointData()
ITouchpointType	getTouchpointType()
IUpdateDescriptor	getUpdateDescriptor() Returns information about what this installable unit is an update of.
Version	getVersion() Returns the version portion of this versioned id.
int	hashCode()
boolean	isResolved() Returns whether this installable unit has been resolved.
boolean	isSingleton() Returns whether this installable unit is a singleton.
static IMatchExpression<IInstallableUnit>	parseFilter(java.lang.String filterStr)
boolean	satisfies(IRequirement candidate) Returns whether this unit has a provided capability that satisfies the given requirement.
void	setArtifacts(IArtifactKey[] value)
void	setCapabilities(IProvidedCapability[] newCapabilities)
void	setCopyright(ICopyright copyright)
void	setFilter(IMatchExpression<IInstallableUnit> filter)
void	setFilter(java.lang.String filter)
void	setId(java.lang.String id)
void	setLicenses(ILicense[] license)
java.lang.String	setLocalizedProperty(java.lang.String key, java.lang.String value)
void	setMetaRequiredCapabilities(IRequirement[] metaReqs)
java.lang.String	setProperty(java.lang.String key, java.lang.String value)
void	setRequiredCapabilities(IRequirement[] capabilities)
void	setSingleton(boolean singleton)
void	setTouchpointType(ITouchpointType type)
void	setUpdateDescriptor(IUpdateDescriptor updateInfo)
void	setVersion(Version newVersion)
java.lang.String	toString()
IInstallableUnit	unresolved() Returns the unresolved equivalent of this installable unit.

Methods inherited from class java.lang.Object

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

Field Detail

MEMBER_PROVIDED_CAPABILITIES

public static final java.lang.String MEMBER_PROVIDED_CAPABILITIES

See Also:

Constant Field Values

MEMBER_ID

public static final java.lang.String MEMBER_ID

See Also:

Constant Field Values

MEMBER_VERSION

public static final java.lang.String MEMBER_VERSION

See Also:

Constant Field Values

MEMBER_PROPERTIES

public static final java.lang.String MEMBER_PROPERTIES

See Also:

Constant Field Values

MEMBER_FILTER

public static final java.lang.String MEMBER_FILTER

See Also:

Constant Field Values

MEMBER_ARTIFACTS

public static final java.lang.String MEMBER_ARTIFACTS

See Also:

Constant Field Values

MEMBER_REQUIREMENTS

public static final java.lang.String MEMBER_REQUIREMENTS

See Also:

Constant Field Values

MEMBER_LICENSES

public static final java.lang.String MEMBER_LICENSES

See Also:

Constant Field Values

MEMBER_COPYRIGHT

public static final java.lang.String MEMBER_COPYRIGHT

See Also:

Constant Field Values

MEMBER_TOUCHPOINT_DATA

public static final java.lang.String MEMBER_TOUCHPOINT_DATA

See Also:

Constant Field Values

MEMBER_TOUCHPOINT_TYPE

public static final java.lang.String MEMBER_TOUCHPOINT_TYPE

See Also:

Constant Field Values

MEMBER_UPDATE_DESCRIPTOR

public static final java.lang.String MEMBER_UPDATE_DESCRIPTOR

See Also:

Constant Field Values

MEMBER_SINGLETON

public static final java.lang.String MEMBER_SINGLETON

See Also:

Constant Field Values

MEMBER_TRANSLATED_PROPERTIES

public static final java.lang.String MEMBER_TRANSLATED_PROPERTIES

See Also:

Constant Field Values

MEMBER_PROFILE_PROPERTIES

public static final java.lang.String MEMBER_PROFILE_PROPERTIES

See Also:

Constant Field Values

Constructor Detail

InstallableUnit

public InstallableUnit()

Method Detail

addTouchpointData

public void addTouchpointData(ITouchpointData newData)

compareTo

public int compareTo(IInstallableUnit other)

Specified by:

compareTo in interface java.lang.Comparable<IInstallableUnit>

equals

public boolean equals(java.lang.Object obj)

Description copied from interface: IInstallableUnit

Returns whether this InstallableUnit is equal to the given object. This method returns true if:

• Both this object and the given object are of type IInstallableUnit
• The result of getId() on both objects are equal
• The result of getVersion() on both objects are equal

Specified by:

equals in interface IInstallableUnit

Overrides:

equals in class java.lang.Object

getArtifacts

public java.util.Collection<IArtifactKey> getArtifacts()

Description copied from interface: IInstallableUnit

Returns the collection of artifacts associated with this installable unit. Installing this unit into a system will cause these artifacts to be fetched from a repository and applied to the installed system. Uninstalling this unit will cause these artifacts to be removed from the system.

Specified by:

getArtifacts in interface IInstallableUnit

Returns:

The artifacts associated with this installable unit

getFilter

public IMatchExpression<IInstallableUnit> getFilter()

Description copied from interface: IInstallableUnit

Returns the filter on this installable unit. The filter is matched against the properties of the environment the unit is installed into. An installable unit will not be installed if it has a filter condition that is not satisfied by the properties of the environment.

Specified by:

getFilter in interface IInstallableUnit

Returns:

The installation filter for this unit, or null

getFragments

public java.util.Collection<IInstallableUnitFragment> getFragments()

Description copied from interface: IInstallableUnit

Returns the fragments that have been bound to this installable unit, or null if this unit is not resolved.

Specified by:

getFragments in interface IInstallableUnit

Returns:

The fragments bound to this installable unit, or null

See Also:

IInstallableUnit.isResolved()

getId

public java.lang.String getId()

Description copied from interface: IVersionedId

Returns the id portion of this versioned id.

Specified by:

getId in interface IVersionedId

Returns:

The id portion of this versioned id.

getProperties

public java.util.Map<java.lang.String,java.lang.String> getProperties()

Get an unmodifiable copy of the properties associated with the installable unit.

Specified by:

getProperties in interface IInstallableUnit

Returns:

an unmodifiable copy of the IU properties.

getLocalizedProperty

public java.lang.String getLocalizedProperty(java.lang.String key)

getProperty

public java.lang.String getProperty(java.lang.String key)

Description copied from interface: IInstallableUnit

Returns the untranslated property of this installable unit associated with the given key. Returns null if no such property is defined.

If the property value has been externalized, this method will return a string containing the translation key rather than a human-readable string. For this reason, clients wishing to obtain the value for a property that is typically translated should use IInstallableUnit.getProperty(String, String) instead.

Specified by:

getProperty in interface IInstallableUnit

Parameters:

key - The property key to retrieve a property value for

Returns:

the property that applies to this installable unit or null

getProvidedCapabilities

public java.util.Collection<IProvidedCapability> getProvidedCapabilities()

Description copied from interface: IInstallableUnit

Returns the collection of capabilities provided by this installable unit.

Specified by:

getProvidedCapabilities in interface IInstallableUnit

Returns:

The collection of capabilities provided by this installable unit.

getProperty

public java.lang.String getProperty(java.lang.String key,
                                    java.lang.String locale)

Description copied from interface: IInstallableUnit

Returns the property of this installable unit associated with the given key. Returns null if no such property is defined or no applicable translation is available.

Specified by:

getProperty in interface IInstallableUnit

Parameters:

key - The property key to retrieve a property value for

locale - The locale to translate the property for, or null to use the current locale.

Returns:

the property that applies to this installable unit or null

getRequirements

public java.util.List<IRequirement> getRequirements()

Specified by:

getRequirements in interface IInstallableUnit

getTouchpointData

public java.util.Collection<ITouchpointData> getTouchpointData()

Specified by:

getTouchpointData in interface IInstallableUnit

getTouchpointType

public ITouchpointType getTouchpointType()

Specified by:

getTouchpointType in interface IInstallableUnit

getVersion

public Version getVersion()

Description copied from interface: IVersionedId

Returns the version portion of this versioned id.

Specified by:

getVersion in interface IVersionedId

Returns:

the version portion of this versioned id.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

isResolved

public boolean isResolved()

Description copied from interface: IInstallableUnit

Returns whether this installable unit has been resolved. A resolved installable unit represents the union of an installable unit and some fragments.

Specified by:

isResolved in interface IInstallableUnit

Returns:

true if this installable unit is resolved, and false otherwise.

See Also:

IInstallableUnit.getFragments(), IInstallableUnit.unresolved()

isSingleton

public boolean isSingleton()

Description copied from interface: IInstallableUnit

Returns whether this installable unit is a singleton. Only one singleton installable unit with a given id is allowed to exist in a given installed system. Attempting to install multiple versions of a singleton will fail.

Specified by:

isSingleton in interface IInstallableUnit

Returns:

true if this unit is a singleton, and false otherwise

setArtifacts

public void setArtifacts(IArtifactKey[] value)

setCapabilities

public void setCapabilities(IProvidedCapability[] newCapabilities)

setFilter

public void setFilter(IMatchExpression<IInstallableUnit> filter)

setFilter

public void setFilter(java.lang.String filter)

setId

public void setId(java.lang.String id)

parseFilter

public static IMatchExpression<IInstallableUnit> parseFilter(java.lang.String filterStr)

setLocalizedProperty

public java.lang.String setLocalizedProperty(java.lang.String key,
                                             java.lang.String value)

setProperty

public java.lang.String setProperty(java.lang.String key,
                                    java.lang.String value)

setRequiredCapabilities

public void setRequiredCapabilities(IRequirement[] capabilities)

setSingleton

public void setSingleton(boolean singleton)

setTouchpointType

public void setTouchpointType(ITouchpointType type)

setVersion

public void setVersion(Version newVersion)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

unresolved

public IInstallableUnit unresolved()

Description copied from interface: IInstallableUnit

Returns the unresolved equivalent of this installable unit. If this unit is already unresolved, this method returns the receiver. Otherwise, this method returns an installable unit with the same id and version, but without any fragments attached.

Specified by:

unresolved in interface IInstallableUnit

Returns:

The unresolved equivalent of this unit

See Also:

IInstallableUnit.getFragments(), IInstallableUnit.isResolved()

getUpdateDescriptor

public IUpdateDescriptor getUpdateDescriptor()

Description copied from interface: IInstallableUnit

Returns information about what this installable unit is an update of.

Specified by:

getUpdateDescriptor in interface IInstallableUnit

Returns:

The lineage information about the installable unit

setUpdateDescriptor

public void setUpdateDescriptor(IUpdateDescriptor updateInfo)

setLicenses

public void setLicenses(ILicense[] license)

getLicenses

public java.util.Collection<ILicense> getLicenses()

Description copied from interface: IInstallableUnit

Returns the untranslated licenses that apply to this installable unit.

If the license text has been externalized, this method will return strings containing the translation keys rather than human-readable strings. For this reason, clients wishing to obtain a license for display to an end user should use IInstallableUnit.getLicenses(String) instead.

Specified by:

getLicenses in interface IInstallableUnit

Returns:

the licenses that apply to this installable unit

getLicenses

public java.util.Collection<ILicense> getLicenses(java.lang.String locale)

Description copied from interface: IInstallableUnit

Returns the licenses that apply to this installable unit. Any translation of the licenses for the given locale will be applied. Returns an empty collection if this unit has no licenses, or if the available licenses are externalized and do not have translations available for the given locale.

Specified by:

getLicenses in interface IInstallableUnit

Parameters:

locale - The locale to translate the license for, or null to use the current locale.

Returns:

the translated licenses that apply to this installable unit

setCopyright

public void setCopyright(ICopyright copyright)

getCopyright

public ICopyright getCopyright()

Description copied from interface: IInstallableUnit

Returns the untranslated copyright that applies to this installable unit.

If the copyright text has been externalized, this method will return strings containing the translation keys rather than human-readable strings. For this reason, clients wishing to obtain a copyright for display to an end user should use IInstallableUnit.getCopyright(String) instead.

Specified by:

getCopyright in interface IInstallableUnit

Returns:

the copyright that applies to this installable unit or null

getCopyright

public ICopyright getCopyright(java.lang.String locale)

Description copied from interface: IInstallableUnit

Returns the copyright that applies to this installable unit. Any translation of the copyright for the given locale will be applied. Returns null if this unit has no copyright, or if the copyright is externalized and no translations are available for the given locale.

Specified by:

getCopyright in interface IInstallableUnit

Parameters:

locale - The locale to translate the copyright for, or null to use the current locale.

Returns:

the copyright that applies to this installable unit or null

satisfies

public boolean satisfies(IRequirement candidate)

Description copied from interface: IInstallableUnit

Returns whether this unit has a provided capability that satisfies the given requirement.

Specified by:

satisfies in interface IInstallableUnit

Returns:

true if this unit satisfies the given requirement, and false otherwise.

getMetaRequirements

public java.util.Collection<IRequirement> getMetaRequirements()

Specified by:

getMetaRequirements in interface IInstallableUnit

setMetaRequiredCapabilities

public void setMetaRequiredCapabilities(IRequirement[] metaReqs)

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

Parameters:

memberName - The name of the member

Returns:

The member value.

contextIU

public static IInstallableUnit contextIU(java.lang.String ws,
                                         java.lang.String os,
                                         java.lang.String arch)

contextIU

public static IInstallableUnit contextIU(java.util.Map<java.lang.String,java.lang.String> environment)