|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Included Feature reference. A reference to a included feature.
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.
FeatureReference
Method Summary | |
---|---|
IFeature |
getFeature()
Deprecated. use getFeature(IProgressMonitor) |
IFeature |
getFeature(boolean perfectMatch,
IConfiguredSite configuredSite)
Deprecated. use getFeature(IProgressMonitor) |
IFeature |
getFeature(boolean perfectMatch,
IConfiguredSite configuredSite,
IProgressMonitor monitor)
Deprecated. use getFeature(IProgressMonitor) |
int |
getMatch()
Deprecated. since 3.0 included feature version is exactly specified |
int |
getSearchLocation()
Returns the search location for this included feature. |
boolean |
isOptional()
Returns true if the feature is optional, false otherwise. |
Methods inherited from interface org.eclipse.update.core.IFeatureReference |
---|
getFeature, getName, getSite, getURL, getVersionedIdentifier, isPatch, setSite, setURL |
Methods inherited from interface org.eclipse.core.runtime.IAdaptable |
---|
getAdapter |
Methods inherited from interface org.eclipse.update.core.IPlatformEnvironment |
---|
getNL, getOS, getOSArch, getWS |
Method Detail |
public IFeature getFeature() throws CoreException
getFeature
in interface IFeatureReference
CoreException
public IFeature getFeature(boolean perfectMatch, 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 IFeature getFeature(boolean perfectMatch, IConfiguredSite configuredSite, IProgressMonitor monitor) 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.monitor
- the progress monitor
CoreException
public boolean isOptional()
true
if the feature is optional, false
otherwise.
public int getMatch()
RULE_PERFECT
IUpdateConstants.RULE_PERFECT
,
IUpdateConstants.RULE_EQUIVALENT
,
IUpdateConstants.RULE_COMPATIBLE
,
IUpdateConstants.RULE_GREATER_OR_EQUAL
public int getSearchLocation()
SEARCH_ROOT
IUpdateConstants.SEARCH_ROOT
,
IUpdateConstants.SEARCH_SELF
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.