org.eclipse.equinox.internal.p2.metadata

Class RequiredCapability

java.lang.Object

org.eclipse.equinox.internal.p2.metadata.Requirement

org.eclipse.equinox.internal.p2.metadata.RequiredCapability

All Implemented Interfaces:

IRequiredCapability, IMemberProvider, IRequirement

public class RequiredCapability
extends Requirement
implements IRequiredCapability

A required capability represents some external constraint on an IInstallableUnit. Each capability represents something an IInstallableUnit needs that it expects to be provided by another IInstallableUnit. Capabilities are entirely generic, and are intended to be capable of representing anything that an IInstallableUnit may need either at install time, or at runtime.

Capabilities are segmented into namespaces. Anyone can introduce new capability namespaces. Some well-known namespaces are introduced directly by the provisioning framework.

See Also:

IInstallableUnit.NAMESPACE_IU_ID

Field Summary

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

description, filter, greedy, matchExpression, max, MEMBER_FILTER, MEMBER_GREEDY, MEMBER_MATCH, MEMBER_MAX, MEMBER_MIN, min

Constructor Summary

Constructors

Constructor and Description
RequiredCapability(java.lang.String namespace, java.lang.String name, VersionRange range, IMatchExpression<IInstallableUnit> filter, int min, int max, boolean greedy, java.lang.String description)
RequiredCapability(java.lang.String namespace, java.lang.String name, VersionRange range, java.lang.String filter, boolean optional, boolean multiple) Deprecated. To be removed once CBI is fixed.
RequiredCapability(java.lang.String namespace, java.lang.String name, VersionRange range, java.lang.String filter, boolean optional, boolean multiple, boolean greedy) Deprecated. To be removed once CBI is fixed.

Method Summary

Modifier and Type	Method and Description
static IMatchExpression<IInstallableUnit>	createMatchExpressionFromRange(java.lang.String namespace, java.lang.String name, VersionRange range)
static java.lang.String	extractName(IMatchExpression<IInstallableUnit> matchExpression)
static java.lang.String	extractNamespace(IMatchExpression<IInstallableUnit> matchExpression)
static VersionRange	extractRange(IMatchExpression<IInstallableUnit> matchExpression)
java.lang.String	getName()
java.lang.String	getNamespace()
VersionRange	getRange() Returns the range of versions that satisfy this required capability.
static boolean	isStrictVersionRequirement(IMatchExpression<IInstallableUnit> matchExpression)
static boolean	isVersionRangeRequirement(IMatchExpression<IInstallableUnit> matchExpression)
java.lang.String	toString()

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

equals, getDescription, getFilter, getMatches, getMax, getMember, getMin, hashCode, isGreedy, isMatch

Methods inherited from class java.lang.Object

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

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

getDescription, getFilter, getMatches, getMax, getMin, isGreedy, isMatch

Constructor Detail

RequiredCapability

@Deprecated
public RequiredCapability(java.lang.String namespace,
                                      java.lang.String name,
                                      VersionRange range,
                                      java.lang.String filter,
                                      boolean optional,
                                      boolean multiple)

Deprecated. To be removed once CBI is fixed.

TODO Remove. This is a private impl class. Users must call the analogous MetadataFactory.createRequirement()

RequiredCapability

@Deprecated
public RequiredCapability(java.lang.String namespace,
                                      java.lang.String name,
                                      VersionRange range,
                                      java.lang.String filter,
                                      boolean optional,
                                      boolean multiple,
                                      boolean greedy)

Deprecated. To be removed once CBI is fixed.

TODO Remove. This is a private impl class. Users must call the analogous MetadataFactory.createRequirement()

RequiredCapability

public RequiredCapability(java.lang.String namespace,
                          java.lang.String name,
                          VersionRange range,
                          IMatchExpression<IInstallableUnit> filter,
                          int min,
                          int max,
                          boolean greedy,
                          java.lang.String description)

Method Detail

getNamespace

public java.lang.String getNamespace()

Specified by:

getNamespace in interface IRequiredCapability

getName

public java.lang.String getName()

Specified by:

getName in interface IRequiredCapability

getRange

public VersionRange getRange()

Description copied from interface: IRequiredCapability

Returns the range of versions that satisfy this required capability. Returns an empty version range (VersionRange.emptyRange if any version will satisfy the capability.

Specified by:

getRange in interface IRequiredCapability

Returns:

the range of versions that satisfy this required capability.

toString

public java.lang.String toString()

Overrides:

toString in class Requirement

createMatchExpressionFromRange

public static IMatchExpression<IInstallableUnit> createMatchExpressionFromRange(java.lang.String namespace,
                                                                                java.lang.String name,
                                                                                VersionRange range)

extractName

public static java.lang.String extractName(IMatchExpression<IInstallableUnit> matchExpression)

extractNamespace

public static java.lang.String extractNamespace(IMatchExpression<IInstallableUnit> matchExpression)

extractRange

public static VersionRange extractRange(IMatchExpression<IInstallableUnit> matchExpression)

isStrictVersionRequirement

public static boolean isStrictVersionRequirement(IMatchExpression<IInstallableUnit> matchExpression)

isVersionRangeRequirement

public static boolean isVersionRangeRequirement(IMatchExpression<IInstallableUnit> matchExpression)