public interface IInstallableUnit extends IVersionedId, Comparable<IInstallableUnit>
Installable units may have dependencies on functionality provided by other installable units, such that the unit cannot be installed unless some other installable unit is present in the installed system that provides a matching capability. Such dependencies are referred to as required capabilities. Conversely, installable units may declared provided capabilities, describing the capabilities that they make available to other units in the system. Note the weak coupling at work here: installable units never directly depend on each other, but instead depend on abstract capabilities that any other installable unit may provide.
Instances of this class are handle objects and do not necessarily
reflect entities that exist in any particular profile or repository. These handle
objects can be created using MetadataFactory
.
MetadataFactory.createInstallableUnit(org.eclipse.equinox.p2.metadata.MetadataFactory.InstallableUnitDescription)
Modifier and Type | Field and Description |
---|---|
static String |
NAMESPACE_IU_ID
A capability namespace representing a particular InstallableUnit by id.
|
static String |
PROP_BUNDLE_LOCALIZATION
A property key (value
"org.eclipse.equinox.p2.bundle.localization" ) for a String
property containing the bundle localization property file name |
static String |
PROP_CONTACT
A property key (value
"org.eclipse.equinox.p2.contact" ) for a
String property containing a contact address where problems can be reported,
such as an email address. |
static String |
PROP_DESCRIPTION
A property key (value
"org.eclipse.equinox.p2.description" ) for a
String property containing a human-readable description of the installable unit. |
static String |
PROP_DESCRIPTION_URL
A property key (value
"org.eclipse.equinox.p2.description.url" ) for a
String property containing a URL to the description of the installable unit. |
static String |
PROP_DOC_URL
A property key (value
"org.eclipse.equinox.p2.doc.url" ) for a
String property containing a URL for documentation about the installable unit. |
static String |
PROP_ICON
A property key (value
"org.eclipse.equinox.p2.icon" ) for a String
property containing a URI for an icon that should be shown when displaying this
installable unit in a user interface. |
static String |
PROP_NAME
A property key (value
"org.eclipse.equinox.p2.name" ) for a
String property containing a human-readable name for the installable unit. |
static String |
PROP_PARTIAL_IU
A property key (value
"org.eclipse.equinox.p2.partial.iu" ) for a
boolean property indicating the IU is generated from incomplete information and
should be replaced by the complete IU if available. |
static String |
PROP_PROVIDER
A property key (value
"org.eclipse.equinox.p2.provider" ) for a
String property containing information about the vendor or provider of the
installable unit. |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj)
Returns whether this InstallableUnit is equal to the given object.
|
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(String locale)
Returns the copyright that applies to this installable unit.
|
IMatchExpression<IInstallableUnit> |
getFilter()
Returns the filter on this installable unit.
|
Collection<IInstallableUnitFragment> |
getFragments()
Returns the fragments that have been bound to this installable unit, or
null if this unit is not resolved. |
Collection<ILicense> |
getLicenses()
Returns the untranslated licenses that apply to this installable unit.
|
Collection<ILicense> |
getLicenses(String locale)
Returns the licenses that apply to this installable unit.
|
Collection<IRequirement> |
getMetaRequirements() |
Map<String,String> |
getProperties()
Returns an unmodifiable copy of the properties
associated with the installable unit.
|
String |
getProperty(String key)
Returns the untranslated property of this installable unit associated with the given key.
|
String |
getProperty(String key,
String locale)
Returns the property of this installable unit associated with the given key.
|
Collection<IProvidedCapability> |
getProvidedCapabilities()
Returns the collection of capabilities provided by this installable unit.
|
Collection<IRequirement> |
getRequirements() |
Collection<ITouchpointData> |
getTouchpointData() |
ITouchpointType |
getTouchpointType() |
IUpdateDescriptor |
getUpdateDescriptor()
Returns information about what this installable unit is an update of.
|
boolean |
isResolved()
Returns whether this installable unit has been resolved.
|
boolean |
isSingleton()
Returns whether this installable unit is a singleton.
|
boolean |
satisfies(IRequirement candidate)
Returns whether this unit has a provided capability that satisfies the given
requirement.
|
IInstallableUnit |
unresolved()
Returns the unresolved equivalent of this installable unit.
|
getId, getVersion
compareTo
static final String NAMESPACE_IU_ID
IVersionedId.getId()
,
Constant Field Valuesstatic final String PROP_PARTIAL_IU
"org.eclipse.equinox.p2.partial.iu"
) for a
boolean property indicating the IU is generated from incomplete information and
should be replaced by the complete IU if available.getProperty(String)
,
Constant Field Valuesstatic final String PROP_CONTACT
"org.eclipse.equinox.p2.contact"
) for a
String property containing a contact address where problems can be reported,
such as an email address.getProperty(String)
,
Constant Field Valuesstatic final String PROP_DESCRIPTION
"org.eclipse.equinox.p2.description"
) for a
String property containing a human-readable description of the installable unit.getProperty(String)
,
Constant Field Valuesstatic final String PROP_DESCRIPTION_URL
"org.eclipse.equinox.p2.description.url"
) for a
String property containing a URL to the description of the installable unit.getProperty(String)
,
Constant Field Valuesstatic final String PROP_DOC_URL
"org.eclipse.equinox.p2.doc.url"
) for a
String property containing a URL for documentation about the installable unit.getProperty(String)
,
Constant Field Valuesstatic final String PROP_BUNDLE_LOCALIZATION
"org.eclipse.equinox.p2.bundle.localization"
) for a String
property containing the bundle localization property file namestatic final String PROP_NAME
"org.eclipse.equinox.p2.name"
) for a
String property containing a human-readable name for the installable unit.getProperty(String)
,
Constant Field Valuesstatic final String PROP_PROVIDER
"org.eclipse.equinox.p2.provider"
) for a
String property containing information about the vendor or provider of the
installable unit.getProperty(String)
,
Constant Field Valuesstatic final String PROP_ICON
"org.eclipse.equinox.p2.icon"
) for a String
property containing a URI for an icon that should be shown when displaying this
installable unit in a user interface.getProperty(String)
,
Constant Field ValuesCollection<IArtifactKey> getArtifacts()
IMatchExpression<IInstallableUnit> getFilter()
null
Collection<IInstallableUnitFragment> getFragments()
null
if this unit is not resolved.null
isResolved()
Map<String,String> getProperties()
String getProperty(String key)
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
getProperty(String, String)
instead.
key
- The property key to retrieve a property value fornull
String getProperty(String key, String locale)
null
if no such property is defined or no applicable
translation is available.key
- The property key to retrieve a property value forlocale
- The locale to translate the property for, or null to use the current locale.null
Collection<IProvidedCapability> getProvidedCapabilities()
Collection<IRequirement> getRequirements()
Collection<IRequirement> getMetaRequirements()
Collection<ITouchpointData> getTouchpointData()
ITouchpointType getTouchpointType()
boolean isResolved()
true
if this installable unit is resolved, and
false
otherwise.getFragments()
,
unresolved()
boolean isSingleton()
true
if this unit is a singleton, and false
otherwiseboolean satisfies(IRequirement candidate)
true
if this unit satisfies the given requirement, and false
otherwise.IInstallableUnit unresolved()
getFragments()
,
isResolved()
IUpdateDescriptor getUpdateDescriptor()
Collection<ILicense> getLicenses()
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 getLicenses(String)
instead.
Collection<ILicense> getLicenses(String locale)
locale
- The locale to translate the license for, or null to use the current locale.ICopyright getCopyright()
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 getCopyright(String)
instead.
null
ICopyright getCopyright(String locale)
null
if this
unit has no copyright, or if the copyright is externalized and no translations are
available for the given locale.locale
- The locale to translate the copyright for, or null to use the current locale.null
boolean equals(Object obj)
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.