Eclipse Platform
2.0

org.eclipse.update.core
Interface IIncludedFeatureReference

All Superinterfaces:
IAdaptable, IFeatureReference
All Known Implementing Classes:
IncludedFeatureReference

public interface IIncludedFeatureReference
extends IFeatureReference

Included Feature reference. A reference to a included 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.1
See Also:
FeatureReference

Method Summary
 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.
 boolean isOptional()
          Returns true if the feature is optional, false otherwise.
 
Methods inherited from interface org.eclipse.update.core.IFeatureReference
addCategory, getCategories, getFeature, getFeature, getSite, getURL, getVersionedIdentifier, setSite, setURL
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 

Method Detail

isOptional

public boolean isOptional()
Returns true if the feature is optional, false otherwise.

Specified by:
isOptional in interface IFeatureReference
Returns:
boolean
Since:
2.0.1

getName

public String getName()
Returns the name of the feature reference.

Specified by:
getName in interface IFeatureReference
Returns:
feature reference name
Since:
2.0.1

getMatch

public int getMatch()
Returns the matching rule for this included feature. The rule will determine the ability of the included feature to move version without causing the overall feature to appear broken. The default is RULE_PERFECT

Specified by:
getMatch in interface IFeatureReference
Returns:
int representation of feature matching rule.
Since:
2.0.2
See Also:
IUpdateConstants.RULE_PERFECT, IUpdateConstants.RULE_EQUIVALENT, IUpdateConstants.RULE_COMPATIBLE, IUpdateConstants.RULE_GREATER_OR_EQUAL

getSearchLocation

public int getSearchLocation()
Returns the search location for this included feature. The location will be used to search updates for this feature. The default is SEARCH_ROOT

Specified by:
getSearchLocation in interface IFeatureReference
Returns:
int representation of feature searching rule.
Since:
2.0.2
See Also:
IFeatureReference#SEARCH_ROOT, IFeatureReference#SEARCH_SELF

Eclipse Platform
2.0

Copyright (c) IBM Corp. and others 2000, 2002. All Rights Reserved.