Eclipse Platform
Release 3.6

org.eclipse.equinox.p2.metadata
Class MetadataFactory.InstallableUnitDescription

java.lang.Object
  extended by org.eclipse.equinox.p2.metadata.MetadataFactory.InstallableUnitDescription
Direct Known Subclasses:
MetadataFactory.InstallableUnitFragmentDescription, MetadataFactory.InstallableUnitPatchDescription
Enclosing class:
MetadataFactory

public static class MetadataFactory.InstallableUnitDescription
extends 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
static 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 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 String PROP_TYPE_GROUP
           
static 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 group.
 
Constructor Summary
MetadataFactory.InstallableUnitDescription()
           
 
Method Summary
 void addProvidedCapabilities(Collection<IProvidedCapability> additional)
           
 void addRequiredCapabilities(Collection<IRequirement> additional)
          Deprecated. Use addRequirements(additional) instead
 void addRequirements(Collection<IRequirement> additional)
           
 void addTouchpointData(ITouchpointData data)
           
 String getId()
           
 Collection<IRequirement> getMetaRequiredCapabilities()
          Deprecated. Use getMetaRequirements() instead
 Collection<IRequirement> getMetaRequirements()
           
 Collection<IProvidedCapability> getProvidedCapabilities()
           
 List<IRequirement> getRequiredCapabilities()
          Deprecated. Use getRequirements() instead
 List<IRequirement> getRequirements()
           
 Collection<ITouchpointData> getTouchpointData()
          Returns the current touchpoint data on this installable unit description.
 Version getVersion()
           
 void setArtifacts(IArtifactKey[] value)
           
 void setCapabilities(IProvidedCapability[] exportedCapabilities)
           
 void setCopyright(ICopyright copyright)
           
 void setFilter(IMatchExpression<IInstallableUnit> filter)
           
 void setFilter(String filter)
           
 void setId(String id)
           
 void setLicenses(ILicense[] licenses)
           
 void setMetaRequiredCapabilities(IRequirement[] metaRequirements)
          Deprecated. Use setMetaRequirements(requirements) instead
 void setMetaRequirements(IRequirement[] metaRequirements)
           
 void setProperty(String key, String value)
           
 void setRequiredCapabilities(IRequirement[] requirements)
          Deprecated. Use setRequirements(requirements) instead
 void setRequirements(IRequirement[] requirements)
           
 void setSingleton(boolean singleton)
           
 void setTouchpointType(ITouchpointType type)
           
 void setUpdateDescriptor(IUpdateDescriptor updateInfo)
           
 void setVersion(Version newVersion)
           
 
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 String PROP_TYPE_GROUP
See Also:
Constant Field Values

PROP_TYPE_PATCH

public static final 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 group.

See Also:
Constant Field Values

PROP_TYPE_FRAGMENT

public static final 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 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
Constructor Detail

MetadataFactory.InstallableUnitDescription

public MetadataFactory.InstallableUnitDescription()
Method Detail

addProvidedCapabilities

public void addProvidedCapabilities(Collection<IProvidedCapability> additional)

addRequiredCapabilities

public void addRequiredCapabilities(Collection<IRequirement> additional)
Deprecated. Use addRequirements(additional) instead


addRequirements

public void addRequirements(Collection<IRequirement> additional)

addTouchpointData

public void addTouchpointData(ITouchpointData data)

getId

public String getId()

getProvidedCapabilities

public Collection<IProvidedCapability> getProvidedCapabilities()

getRequiredCapabilities

public List<IRequirement> getRequiredCapabilities()
Deprecated. Use getRequirements() instead


getRequirements

public List<IRequirement> getRequirements()

getMetaRequiredCapabilities

public Collection<IRequirement> getMetaRequiredCapabilities()
Deprecated. Use getMetaRequirements() instead


getMetaRequirements

public Collection<IRequirement> getMetaRequirements()

getTouchpointData

public 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()

setArtifacts

public void setArtifacts(IArtifactKey[] value)

setCapabilities

public void setCapabilities(IProvidedCapability[] exportedCapabilities)

setCopyright

public void setCopyright(ICopyright copyright)

setFilter

public void setFilter(IMatchExpression<IInstallableUnit> filter)

setFilter

public void setFilter(String filter)

setId

public void setId(String id)

setLicenses

public void setLicenses(ILicense[] licenses)

setProperty

public void setProperty(String key,
                        String value)

setRequiredCapabilities

public void setRequiredCapabilities(IRequirement[] requirements)
Deprecated. Use setRequirements(requirements) instead


setRequirements

public void setRequirements(IRequirement[] requirements)

setMetaRequiredCapabilities

public void setMetaRequiredCapabilities(IRequirement[] metaRequirements)
Deprecated. Use setMetaRequirements(requirements) instead


setMetaRequirements

public void setMetaRequirements(IRequirement[] metaRequirements)

setSingleton

public void setSingleton(boolean singleton)

setTouchpointType

public void setTouchpointType(ITouchpointType type)

setUpdateDescriptor

public void setUpdateDescriptor(IUpdateDescriptor updateInfo)

setVersion

public void setVersion(Version newVersion)

Eclipse Platform
Release 3.6

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.