org.eclipse.update.core
Interface IFeatureReference

All Superinterfaces:

IAdaptable

All Known Implementing Classes:

FeatureReference

public interface IFeatureReference

extends IAdaptable

Feature reference. A reference to a feature on a particular update site.

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

Since:

2.0

See Also:

FeatureReference

Method Summary

void	addCategory(ICategory category) Adds a category to the referenced feature.
ICategory[]	getCategories() Returns an array of categories the referenced feature belong to.
IFeature	getFeature() Returns the referenced feature.
ISite	getSite() Returns the update site for the referenced feature
URL	getURL() Returns the referenced feature URL.
VersionedIdentifier	getVersionedIdentifier() Returns the feature identifier.
void	setSite(ISite site) Associates a site with the feature reference.
void	setURL(URL url) Sets the feature reference URL.

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

getAdapter

Method Detail

getURL

public URL getURL()

Returns the referenced feature URL.

Returns:

feature URL

Since:

2.0

getSite

public ISite getSite()

Returns the update site for the referenced feature

Returns:

feature site

Since:

2.0

getCategories

public ICategory[] getCategories()

Returns an array of categories the referenced feature belong to.

Returns:

an array of categories, or an empty array

Since:

2.0

getFeature

public IFeature getFeature()
                    throws CoreException

Returns the referenced feature. This is a factory method that creates the full feature object.

Returns:

the referenced feature

CoreException

Since:

2.0

getVersionedIdentifier

public VersionedIdentifier getVersionedIdentifier()
                                           throws CoreException

Returns the feature identifier.

Returns:

the feature identifier.

Throws:

CoreException

Since:

2.0

addCategory

public void addCategory(ICategory category)

Adds a category to the referenced feature.

Parameters:

category - new category

Since:

2.0

setURL

public void setURL(URL url)
            throws CoreException

Sets the feature reference URL. This is typically performed as part of the feature reference creation operation. Once set, the url should not be reset.

Parameters:

url - reference URL

CoreException

Since:

2.0

setSite

public void setSite(ISite site)

Associates a site with the feature reference. This is typically performed as part of the feature reference creation operation. Once set, the site should not be reset.

Parameters:

site - site for the feature reference

Since:

2.0