org.eclipse.core.runtime
Interface IPluginPrerequisite

public interface IPluginPrerequisite

A prerequisite entry declared by a plug-in. The declaration causes classes defined by the prerequisite plug-in to be visible to the plug-in that declared the dependency.

This interface is not intended to be implemented by developers.

See Also:

IPluginDescriptor.getPluginPrerequisites()

Method Summary

PluginVersionIdentifier	getResolvedVersionIdentifier() Returns the actual version identifier that is used at runtime to resolve this prerequisite dependency, or null, if the dependency is not resolved.
String	getUniqueIdentifier() Returns the plug-in identifier of the prerequisite plug-in.
PluginVersionIdentifier	getVersionIdentifier() Returns the version identifier of the prerequisite plug-in, or null if none.
boolean	isExported() Indicates whether this prerequisite plug-in is further exposed to any plug-ins that declare a dependency on this plug-in.
boolean	isMatchedAsCompatible() Indicates that this plug-in prerequisite can be resolved against a configured plug-in with a compatible identifier.
boolean	isMatchedAsEquivalent() Indicates that this plug-in prerequisite can only be resolved against a configured plug-in with an equivalent plug-in identifier.
boolean	isMatchedAsExact() Indicates that this plug-in prerequisite can only be resolved against a configured plug-in with exactly the same plug-in identifier.
boolean	isMatchedAsGreaterOrEqual() Indicates that this plug-in prerequisite can be resolved against a configured plug-in with an identifier that is greater than or equal to it.
boolean	isMatchedAsPerfect() Indicates that this plug-in prerequisite can only be resolved against a configured plug-in with a plug-in identifier that is perfectly equal.
boolean	isOptional() Indicates whether this plug-in prerequisite is optional.

Method Detail

getResolvedVersionIdentifier

public PluginVersionIdentifier getResolvedVersionIdentifier()

Returns the actual version identifier that is used at runtime to resolve this prerequisite dependency, or null, if the dependency is not resolved.

Returns:

the plug-in version identifier, or null

getUniqueIdentifier

public String getUniqueIdentifier()

Returns the plug-in identifier of the prerequisite plug-in.

Returns:

the plug-in identifier

getVersionIdentifier

public PluginVersionIdentifier getVersionIdentifier()

Returns the version identifier of the prerequisite plug-in, or null if none.

Returns:

the plug-in version identifier, or null if none was specified

isExported

public boolean isExported()

Indicates whether this prerequisite plug-in is further exposed to any plug-ins that declare a dependency on this plug-in. This allows for chaining of dependencies. For example, if plug-in A depends on plug-in B which depends on plug-in C, the classes from C are typically visible to B, but not to A. A can get around this if either B explicitly exports its dependency on C, or A explicitly declares C as a prerequisite in addition to B.

Returns:

true if this prerequisite plug-in is exposed, false otherwise

isMatchedAsGreaterOrEqual

public boolean isMatchedAsGreaterOrEqual()

Indicates that this plug-in prerequisite can be resolved against a configured plug-in with an identifier that is greater than or equal to it.

Returns:

true if greater or equal match is allowed, false otherwise.

Since:

2.0

isMatchedAsCompatible

public boolean isMatchedAsCompatible()

Indicates that this plug-in prerequisite can be resolved against a configured plug-in with a compatible identifier.

Returns:

true if compatible match is allowed, false if exact match is required.

isMatchedAsEquivalent

public boolean isMatchedAsEquivalent()

Indicates that this plug-in prerequisite can only be resolved against a configured plug-in with an equivalent plug-in identifier.

Returns:

true if only equivalent identifier match satisfies this dependency, false otherwise.

Since:

2.0

isMatchedAsPerfect

public boolean isMatchedAsPerfect()

Indicates that this plug-in prerequisite can only be resolved against a configured plug-in with a plug-in identifier that is perfectly equal.

Returns:

true if only perfectly equal identifier match satisfies this dependency, false otherwise.

Since:

2.0

isMatchedAsExact

public boolean isMatchedAsExact()

Indicates that this plug-in prerequisite can only be resolved against a configured plug-in with exactly the same plug-in identifier.

Returns:

true if only exact identifier match satisfies this dependency, false if compatible plug-in will satisfy this dependency.

isOptional

public boolean isOptional()

Indicates whether this plug-in prerequisite is optional. If a required (i.e., non-optional) prerequisite is missing, this plugin is disabled.

Returns:

true if this prerequisite is optional, false otherwise