|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
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. |
IFeature |
getFeature(boolean perfectMatch,
org.eclipse.update.configuration.IConfiguredSite configuredSite)
Returns the referenced feature. |
int |
getMatch()
Returns the matching rule for this included feature. |
String |
getName()
Returns the name of the feature reference. |
int |
getSearchLocation()
Returns the search location for this included feature. |
ISite |
getSite()
Returns the update site for the referenced feature |
URL |
getURL()
Returns the referenced feature URL. |
VersionedIdentifier |
getVersionedIdentifier()
Returns the feature identifier. |
boolean |
isOptional()
Returns true if the feature is optional, false otherwise. |
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 |
public URL getURL()
public ISite getSite()
public ICategory[] getCategories()
public IFeature getFeature() throws CoreException
CoreException
public IFeature getFeature(boolean perfectMatch, org.eclipse.update.configuration.IConfiguredSite configuredSite) throws CoreException
perfectMatch
- true
if the perfect match feature feature should be returned
false
if the best match feature should be returned.configuredSite
- the configured site to search for the Feature. If
the configured site is null
the search will be done in the current configured site.
CoreException
public VersionedIdentifier getVersionedIdentifier() throws CoreException
CoreException
public void addCategory(ICategory category)
category
- new categorypublic void setURL(URL url) throws CoreException
url
- reference URL
CoreException
public void setSite(ISite site)
site
- site for the feature referencepublic boolean isOptional()
true
if the feature is optional, false
otherwise.
public String getName()
public int getMatch()
RULE_PERFECT
IUpdateConstants.RULE_PERFECT
,
IUpdateConstants.RULE_EQUIVALENT
,
IUpdateConstants.RULE_COMPATIBLE
,
IUpdateConstants.RULE_GREATER_OR_EQUAL
public int getSearchLocation()
SEARCH_ROOT
IFeatureReference#SEARCH_ROOT
,
IFeatureReference#SEARCH_SELF
|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |