Eclipse Plug-in Developer Guide (Galileo) - IImport (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.update.core
Interface IImport

All Superinterfaces:: IAdaptable, IPlatformEnvironment, IUpdateConstants

All Known Implementing Classes:: Import

Deprecated. The org.eclipse.update component has been replaced by Equinox p2. This provisional API was never promoted to stable API, and may be removed from a future release of the platform.

public interface IImport
extends IAdaptable, IUpdateConstants, IPlatformEnvironment
extends IAdaptable, IUpdateConstants, IPlatformEnvironment

Plug-in dependency entry. Describes a feature dependency on a particular plug-in. The dependency can specify a specific plug-in version and a matching rule for satisfying the dependency.

Clients may implement this interface. However, in most cases clients should directly instantiate or subclass the provided implementation of this interface.

Note: This class/interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

Since:: 2.0
See Also:: Import

Field Summary

static int KIND_FEATURE
          Deprecated. The import relates to a feature

static int KIND_PLUGIN
          Deprecated. The import relates to a plugin

Fields inherited from interface org.eclipse.update.core. IUpdateConstants

RULE_COMPATIBLE, RULE_EQUIVALENT, RULE_GREATER_OR_EQUAL, RULE_NONE, RULE_PERFECT, RULE_PREFIX, SEARCH_ROOT, SEARCH_SELF

Method Summary

int getIdRule ()
          Deprecated. Returns the matching rule for the dependency identifier.

int getKind ()
          Deprecated. Returns the dependency kind

int getRule ()
          Deprecated. Returns the matching rule for the dependency.

VersionedIdentifier getVersionedIdentifier ()
          Deprecated. Returns an identifier of the dependent plug-in.

boolean isPatch ()
          Deprecated. Returns the patch mode.

Methods inherited from interface org.eclipse.update.core. IPlatformEnvironment

getNL, getOS, getOSArch, getWS

Methods inherited from interface org.eclipse.core.runtime. IAdaptable

getAdapter

Field Detail

KIND_PLUGIN

static final int KIND_PLUGIN

Deprecated.

The import relates to a plugin

Since:: 2.0.2
See Also:: Constant Field Values

KIND_FEATURE

static final int KIND_FEATURE

Deprecated.

The import relates to a feature

Since:: 2.0.2
See Also:: Constant Field Values

Method Detail

getVersionedIdentifier


VersionedIdentifier getVersionedIdentifier()

Deprecated.

Returns an identifier of the dependent plug-in.

Returns:: plug-in identifier
Since:: 2.0

getRule

int getRule()

Deprecated.

Returns the matching rule for the dependency.

Returns:: matching rule
Since:: 2.0

getIdRule

int getIdRule()

Deprecated.

Returns the matching rule for the dependency identifier.

Returns:: matching id rule
Since:: 2.1

getKind

int getKind()

Deprecated.

Returns the dependency kind

Returns:: KIND_PLUGIN if the dependency relates to a plugin, KIND_FEATURE if the dependency relates to a feature.
See Also:: KIND_PLUGIN, KIND_FEATURE

isPatch

boolean isPatch()

Deprecated.

Returns the patch mode. If the import is in patch mode, the referenced feature is considered a patch target, and the feature that owns the import is patch carrier. Patch carrier and patched feature are linked in a distinct way: if a patched feature is disabled, all the patches are disabled with it.