MetadataFactory.InstallableUnitDescription

java.lang.Object
- org.eclipse.equinox.p2.metadata.MetadataFactory.InstallableUnitDescription

Direct Known Subclasses:

MetadataFactory.InstallableUnitFragmentDescription, MetadataFactory.InstallableUnitPatchDescription

Enclosing class:

MetadataFactory
```
public static class MetadataFactory.InstallableUnitDescription
extends java.lang.Object
```
A description containing information about an installable unit. Once created, installable units are immutable. This description class allows a client to build up the state for an installable unit incrementally, and then finally produce the resulting immutable unit.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`PROP_TYPE_CATEGORY` A property key (value `"org.eclipse.equinox.p2.type.category"`) for a boolean property indicating that an installable unit is a category.
`static java.lang.String`	`PROP_TYPE_FRAGMENT` A property key (value `"org.eclipse.equinox.p2.type.fragment"`) for a boolean property indicating that an installable unit is a fragment.
`static java.lang.String`	`PROP_TYPE_GROUP` A property key (value `"org.eclipse.equinox.p2.type.patch"`) for a boolean property indicating that an installable unit is a group.
`static java.lang.String`	`PROP_TYPE_PATCH` A property key (value `"org.eclipse.equinox.p2.type.patch"`) for a boolean property indicating that an installable unit is a patch.
`static java.lang.String`	`PROP_TYPE_PRODUCT` A property key (value `"org.eclipse.equinox.p2.type.product"`) for a boolean property indicating that an installable unit is the root IU of a product.

Constructor Summary

Constructors
Constructor and Description

InstallableUnitDescription()

Constructors
Constructor and Description
`InstallableUnitDescription()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addProvidedCapabilities(java.util.Collection<IProvidedCapability> additional)` Add the specified capabilities to the installable unit.
`void`	`addRequiredCapabilities(java.util.Collection<IRequirement> additional)` Deprecated. Use addRequirements(additional) instead
`void`	`addRequirements(java.util.Collection<IRequirement> additional)` Add the specified requirements to the installable unit.
`void`	`addTouchpointData(ITouchpointData data)`
`java.lang.String`	`getId()` Returns the id of the installable unit.
`java.util.Collection<IRequirement>`	`getMetaRequiredCapabilities()` Deprecated. Use getMetaRequirements() instead
`java.util.Collection<IRequirement>`	`getMetaRequirements()` Return a collection of the meta requirements specified on this installable unit.
`java.util.Collection<IProvidedCapability>`	`getProvidedCapabilities()` Return a collection of all the capabilities specified on this installable unit.
`java.util.List<IRequirement>`	`getRequiredCapabilities()` Deprecated. Use getRequirements() instead
`java.util.List<IRequirement>`	`getRequirements()` Return a collection of the requirements specified on this installable unit.
`java.util.Collection<ITouchpointData>`	`getTouchpointData()` Returns the current touchpoint data on this installable unit description.
`IUpdateDescriptor`	`getUpdateDescriptor()` Returns the UpdateDescriptor for this IU
`Version`	`getVersion()` Return the versiono on this installable unit description.
`void`	`setArtifacts(IArtifactKey[] value)` Set the artifact keys for the installable unit.
`void`	`setCapabilities(IProvidedCapability[] exportedCapabilities)` Set the capabilities for the installable unit.
`void`	`setCopyright(ICopyright copyright)` Set the copyright for the installable unit.
`void`	`setFilter(IMatchExpression<IInstallableUnit> filter)`
`void`	`setFilter(java.lang.String filter)`
`void`	`setId(java.lang.String id)` Set the id of the installable unit.
`void`	`setLicenses(ILicense[] licenses)` Set the licenses for the installable unit.
`void`	`setMetaRequiredCapabilities(IRequirement[] metaRequirements)` Deprecated. Use setMetaRequirements(requirements) instead
`void`	`setMetaRequirements(IRequirement[] metaRequirements)` Set the meta requirements for the installable unit.
`void`	`setProperty(java.lang.String key, java.lang.String value)` Set a property with a specified value for this installable unit.
`void`	`setRequiredCapabilities(IRequirement[] requirements)` Deprecated. Use setRequirements(requirements) instead
`void`	`setRequirements(IRequirement[] requirements)` Set the requirements for the installable unit.
`void`	`setSingleton(boolean singleton)` Change the singleton status of the installable unit.
`void`	`setTouchpointType(ITouchpointType type)` Set the touchpoint type for the installable unit.
`void`	`setUpdateDescriptor(IUpdateDescriptor updateInfo)` Set the update descriptor for the installable unit.
`void`	`setVersion(Version newVersion)` Set the version of this installable unit.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PROP_TYPE_GROUP
```
public static final java.lang.String PROP_TYPE_GROUP
```
    A property key (value "org.eclipse.equinox.p2.type.patch") for a boolean property indicating that an installable unit is a group.
    
    See Also:
    
    Constant Field Values
  - PROP_TYPE_PATCH
```
public static final java.lang.String PROP_TYPE_PATCH
```
    A property key (value "org.eclipse.equinox.p2.type.patch") for a boolean property indicating that an installable unit is a patch.
    
    See Also:
    
    Constant Field Values
  - PROP_TYPE_FRAGMENT
```
public static final java.lang.String PROP_TYPE_FRAGMENT
```
    A property key (value "org.eclipse.equinox.p2.type.fragment") for a boolean property indicating that an installable unit is a fragment.
    
    See Also:
    
    Constant Field Values
  - PROP_TYPE_CATEGORY
```
public static final java.lang.String PROP_TYPE_CATEGORY
```
    A property key (value "org.eclipse.equinox.p2.type.category") for a boolean property indicating that an installable unit is a category.
    
    See Also:
    
    Constant Field Values
  - PROP_TYPE_PRODUCT
```
public static final java.lang.String PROP_TYPE_PRODUCT
```
    A property key (value "org.eclipse.equinox.p2.type.product") for a boolean property indicating that an installable unit is the root IU of a product.
    
    Since:
    
    2.2
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - InstallableUnitDescription
```
public InstallableUnitDescription()
```
- Method Detail
  - addProvidedCapabilities
```
public void addProvidedCapabilities(java.util.Collection<IProvidedCapability> additional)
```
    Add the specified capabilities to the installable unit.
    
    Parameters:
    
    additional - the capabilities to add.
  - addRequiredCapabilities
```
@Deprecated
public void addRequiredCapabilities(java.util.Collection<IRequirement> additional)
```
    Deprecated. Use addRequirements(additional) instead
  - addRequirements
```
public void addRequirements(java.util.Collection<IRequirement> additional)
```
    Add the specified requirements to the installable unit.
    
    Parameters:
    
    additional - the requirements to add
  - addTouchpointData
```
public void addTouchpointData(ITouchpointData data)
```
  - getId
```
public java.lang.String getId()
```
    Returns the id of the installable unit.
  - getProvidedCapabilities
```
public java.util.Collection<IProvidedCapability> getProvidedCapabilities()
```
    Return a collection of all the capabilities specified on this installable unit.
  - getRequiredCapabilities
```
@Deprecated
public java.util.List<IRequirement> getRequiredCapabilities()
```
    Deprecated. Use getRequirements() instead
  - getRequirements
```
public java.util.List<IRequirement> getRequirements()
```
    Return a collection of the requirements specified on this installable unit.
  - getMetaRequiredCapabilities
```
@Deprecated
public java.util.Collection<IRequirement> getMetaRequiredCapabilities()
```
    Deprecated. Use getMetaRequirements() instead
  - getMetaRequirements
```
public java.util.Collection<IRequirement> getMetaRequirements()
```
    Return a collection of the meta requirements specified on this installable unit.
  - getTouchpointData
```
public java.util.Collection<ITouchpointData> getTouchpointData()
```
    Returns the current touchpoint data on this installable unit description. The touchpoint data may change if further data is added to the description.
    
    Returns:
    
    The current touchpoint data on this description
  - getVersion
```
public Version getVersion()
```
    Return the versiono on this installable unit description.
  - getUpdateDescriptor
```
public IUpdateDescriptor getUpdateDescriptor()
```
    Returns the UpdateDescriptor for this IU
    
    Since:
    
    2.1
  - setArtifacts
```
public void setArtifacts(IArtifactKey[] value)
```
    Set the artifact keys for the installable unit. Previous values will be overwritten.
    
    Parameters:
    
    value - the artifacts to the used.
  - setCapabilities
```
public void setCapabilities(IProvidedCapability[] exportedCapabilities)
```
    Set the capabilities for the installable unit. Previous values will be overwritten.
    
    Parameters:
    
    exportedCapabilities - the capabilities to be used.
  - setCopyright
```
public void setCopyright(ICopyright copyright)
```
    Set the copyright for the installable unit. Previous values will be overwritten.
    
    Parameters:
    
    copyright - the copyright to be used.
  - setFilter
```
public void setFilter(IMatchExpression<IInstallableUnit> filter)
```
  - setFilter
```
public void setFilter(java.lang.String filter)
```
  - setId
```
public void setId(java.lang.String id)
```
    Set the id of the installable unit.
  - setLicenses
```
public void setLicenses(ILicense[] licenses)
```
    Set the licenses for the installable unit. Previous values will be overwritten.
  - setProperty
```
public void setProperty(java.lang.String key,
                        java.lang.String value)
```
    Set a property with a specified value for this installable unit.
    
    Parameters:
    
    key - key with which the specified value is to be associated
    
    value - value to be associated with the specified key
  - setRequiredCapabilities
```
@Deprecated
public void setRequiredCapabilities(IRequirement[] requirements)
```
    Deprecated. Use setRequirements(requirements) instead
  - setRequirements
```
public void setRequirements(IRequirement[] requirements)
```
    Set the requirements for the installable unit. Previous values will be overwritten.
    
    Parameters:
    
    requirements - the requirements to be used.
  - setMetaRequiredCapabilities
```
@Deprecated
public void setMetaRequiredCapabilities(IRequirement[] metaRequirements)
```
    Deprecated. Use setMetaRequirements(requirements) instead
  - setMetaRequirements
```
public void setMetaRequirements(IRequirement[] metaRequirements)
```
    Set the meta requirements for the installable unit. Previous values will be overwritten.
    
    Parameters:
    
    metaRequirements - the meta requirements to be used.
  - setSingleton
```
public void setSingleton(boolean singleton)
```
    Change the singleton status of the installable unit.
  - setTouchpointType
```
public void setTouchpointType(ITouchpointType type)
```
    Set the touchpoint type for the installable unit.
  - setUpdateDescriptor
```
public void setUpdateDescriptor(IUpdateDescriptor updateInfo)
```
    Set the update descriptor for the installable unit.
  - setVersion
```
public void setVersion(Version newVersion)
```
    Set the version of this installable unit.
    
    Parameters:
    
    newVersion - version to be set on the installable unit.

Class MetadataFactory.InstallableUnitDescription

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROP_TYPE_GROUP

PROP_TYPE_PATCH

PROP_TYPE_FRAGMENT

PROP_TYPE_CATEGORY

PROP_TYPE_PRODUCT

Constructor Detail

InstallableUnitDescription

Method Detail

addProvidedCapabilities

addRequiredCapabilities

addRequirements

addTouchpointData

getId

getProvidedCapabilities

getRequiredCapabilities

getRequirements

getMetaRequiredCapabilities

getMetaRequirements

getTouchpointData

getVersion

getUpdateDescriptor

setArtifacts

setCapabilities

setCopyright

setFilter

setFilter

setId

setLicenses

setProperty

setRequiredCapabilities

setRequirements

setMetaRequiredCapabilities

setMetaRequirements

setSingleton

setTouchpointType

setUpdateDescriptor

setVersion