org.eclipse.equinox.internal.p2.metadata

Class RequiredCapability

java.lang.Object

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

All Implemented Interfaces:

IRequiredCapability, IMemberProvider, IRequirement

public class RequiredCapability
extends java.lang.Object
implements IRequiredCapability, IMemberProvider

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

Modifier and Type	Field and Description
static java.lang.String	MEMBER_FILTER
static java.lang.String	MEMBER_GREEDY
static java.lang.String	MEMBER_MATCH
static java.lang.String	MEMBER_MAX
static java.lang.String	MEMBER_MIN

Constructor Summary

Constructors

Constructor and Description
RequiredCapability(IMatchExpression<IInstallableUnit> requirement, IMatchExpression<IInstallableUnit> filter, int min, int max, boolean greedy, java.lang.String 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) TODO replace booleans with int options flag.
RequiredCapability(java.lang.String namespace, java.lang.String name, VersionRange range, java.lang.String filter, boolean optional, boolean multiple, boolean greedy)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
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	getDescription() Returns a textual description of this requirement.
IMatchExpression<IInstallableUnit>	getFilter()
IMatchExpression<IInstallableUnit>	getMatches() Returns a boolean match expression that will return true for any IInstallableUnit that matches the requirement.
int	getMax() Returns the maximum cardinality of the requirement.
java.lang.Object	getMember(java.lang.String memberName) Returns the value for the specified member.
int	getMin() Returns the minimum cardinality of the requirement.
java.lang.String	getName()
java.lang.String	getNamespace()
VersionRange	getRange() Returns the range of versions that satisfy this required capability.
int	hashCode()
boolean	isGreedy() Returns whether this requirement should cause extra installable units to be installed in order to satisfy it.
boolean	isMatch(IInstallableUnit candidate) Returns whether the provided capabilities of the given installable unit satisfy this requirement.
static boolean	isSimpleRequirement(IMatchExpression<IInstallableUnit> matchExpression)
static boolean	isVersionStrict(IMatchExpression<IInstallableUnit> matchExpression)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

MEMBER_FILTER

public static final java.lang.String MEMBER_FILTER

See Also:

Constant Field Values

MEMBER_MIN

public static final java.lang.String MEMBER_MIN

See Also:

Constant Field Values

MEMBER_MAX

public static final java.lang.String MEMBER_MAX

See Also:

Constant Field Values

MEMBER_GREEDY

public static final java.lang.String MEMBER_GREEDY

See Also:

Constant Field Values

MEMBER_MATCH

public static final java.lang.String MEMBER_MATCH

See Also:

Constant Field Values

Constructor Detail

RequiredCapability

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

TODO replace booleans with int options flag.

RequiredCapability

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

RequiredCapability

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

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

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getName

public java.lang.String getName()

Specified by:

getName in interface IRequiredCapability

getNamespace

public java.lang.String getNamespace()

Specified by:

getNamespace in interface IRequiredCapability

getRange

public VersionRange getRange()

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.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

isGreedy

public boolean isGreedy()

Description copied from interface: IRequirement

Returns whether this requirement should cause extra installable units to be installed in order to satisfy it.

Specified by:

isGreedy in interface IRequirement

Returns:

true if additional installable units should be installed to satisfy this requirement, and false otherwise

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getMin

public int getMin()

Description copied from interface: IRequirement

Returns the minimum cardinality of the requirement. That is, the minimum number of capabilities that must be provided that match this requirement before this requirement is considered fully satisfied. A minimum cardinality of 0 indicates that the requirement is optional.

Specified by:

getMin in interface IRequirement

Returns:

the minimum cardinality of this requirement

getMax

public int getMax()

Description copied from interface: IRequirement

Returns the maximum cardinality of the requirement. That is, the maximum number of capabilities that are permitted to be present that satisfy this requirement. A maximum cardinality of 0 indicates that there must not be any installable unit in the system that satisfies this requirement.

Specified by:

getMax in interface IRequirement

Returns:

the maximum cardinality of this requirement

getMatches

public IMatchExpression<IInstallableUnit> getMatches()

Description copied from interface: IRequirement

Returns a boolean match expression that will return true for any IInstallableUnit that matches the requirement.

Specified by:

getMatches in interface IRequirement

Returns:

A boolean match expression for installable unit matching.

getFilter

public IMatchExpression<IInstallableUnit> getFilter()

Specified by:

getFilter in interface IRequirement

isMatch

public boolean isMatch(IInstallableUnit candidate)

Description copied from interface: IRequirement

Returns whether the provided capabilities of the given installable unit satisfy this requirement.

Specified by:

isMatch in interface IRequirement

Parameters:

candidate - the installable unit to check for matching capabilities

Returns:

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

isVersionStrict

public static boolean isVersionStrict(IMatchExpression<IInstallableUnit> matchExpression)

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)

isSimpleRequirement

public static boolean isSimpleRequirement(IMatchExpression<IInstallableUnit> matchExpression)

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.

getDescription

public java.lang.String getDescription()

Description copied from interface: IRequirement

Returns a textual description of this requirement.

Specified by:

getDescription in interface IRequirement

Returns:

a textual description of this requirement