Eclipse Platform
2.0

org.eclipse.update.core
Class IncludedFeatureReference

java.lang.Object
  |
  +--org.eclipse.core.runtime.PlatformObject
        |
        +--org.eclipse.update.core.model.ModelObject
              |
              +--org.eclipse.update.core.model.FeatureReferenceModel
                    |
                    +--org.eclipse.update.core.FeatureReference
                          |
                          +--org.eclipse.update.core.IncludedFeatureReference
All Implemented Interfaces:
IAdaptable, IFeatureReference, IIncludedFeatureReference

public class IncludedFeatureReference
extends FeatureReference
implements IIncludedFeatureReference

This is a utility class representing the options of a nested feature. Feature will include other features. This class will represent the options of the inclusion.

Clients may instantiate; not intended to be subclassed by clients.

Since:
2.0.1
See Also:
VersionedIdentifier

Constructor Summary
IncludedFeatureReference(String name, boolean isOptional)
          Deprecated. use other constructor
IncludedFeatureReference(String name, boolean isOptional, int matchingRule, int searchLocation)
          Construct a feature options
 
Method Summary
 int getMatch()
          Returns the matching rule for this included feature.
 String getName()
          Returns a string representation of the feature identifier.
 int getSearchLocation()
          Returns the search location for this included feature.
 boolean isOptional()
          Returns the isOptional
 
Methods inherited from class org.eclipse.update.core.FeatureReference
addCategory, getCategories, getFeature, getFeature, getSite, getVersionedIdentifier, setSite, setURL
 
Methods inherited from class org.eclipse.update.core.model.FeatureReferenceModel
addCategoryName, equals, getCategoryNames, getFeatureIdentifier, getFeatureVersion, getOptions, getSiteModel, getType, getURL, getURLString, removeCategoryName, resolve, setCategoryNames, setFeatureIdentifier, setFeatureVersion, setOptions, setSiteModel, setType, setURLString, toString
 
Methods inherited from class org.eclipse.update.core.model.ModelObject
arrayTypeFor, arrayTypeFor, assertIsWriteable, isReadOnly, markListReferenceReadOnly, markReadOnly, markReferenceReadOnly, resolveListReference, resolveNLString, resolveReference, resolveURL
 
Methods inherited from class org.eclipse.core.runtime.PlatformObject
getAdapter
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
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
 

Constructor Detail

IncludedFeatureReference

public IncludedFeatureReference(String name,
                                boolean isOptional)
Deprecated. use other constructor

Construct a feature options from a string and a boolean The string is the representation of the name. The boolean is the representation of the optionality of the nested feature.

Parameters:
name - string representation of the feature
isOptional - true if the feature is optional, false otherwise.
Since:
2.0.1

IncludedFeatureReference

public IncludedFeatureReference(String name,
                                boolean isOptional,
                                int matchingRule,
                                int searchLocation)
Construct a feature options

Parameters:
name - string representation of the feature
isOptional - true if the feature is optional, false otherwise.
matchingRule - the matching rule
searchLocation - the location to search for this feature's updates.
Since:
2.0.2
Method Detail

isOptional

public boolean isOptional()
Returns the isOptional

Specified by:
isOptional in interface IIncludedFeatureReference
Overrides:
isOptional in class FeatureReference
Returns:
isOptional
Since:
2.0.1

getName

public String getName()
Returns a string representation of the feature identifier.

Specified by:
getName in interface IIncludedFeatureReference
Overrides:
getName in class FeatureReference
Returns:
string representation of feature identifier or null.
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 MATCH_PERFECT

Specified by:
getMatch in interface IIncludedFeatureReference
Overrides:
getMatch in class FeatureReference
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 IIncludedFeatureReference
Overrides:
getSearchLocation in class FeatureReference
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.