Eclipse Platform
2.1

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.model.IncludedFeatureReferenceModel
                                |
                                +--org.eclipse.update.core.IncludedFeatureReference
All Implemented Interfaces:
IAdaptable, IFeatureReference, IIncludedFeatureReference, IPlatformEnvironment

public class IncludedFeatureReference
extends IncludedFeatureReferenceModel
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()
          Construct a included feature reference
IncludedFeatureReference(IFeatureReference featureReference)
          Constructor IncludedFeatureReference.
IncludedFeatureReference(IIncludedFeatureReference includedFeatureRef)
          Construct a feature options
 
Method Summary
 IFeature getFeature()
          Returns the referenced feature.
 IFeature getFeature(boolean perfectMatch, org.eclipse.update.configuration.IConfiguredSite configuredSite)
          Returns the referenced feature.
 IFeature getFeature(boolean perfectMatch, org.eclipse.update.configuration.IConfiguredSite configuredSite, IProgressMonitor monitor)
          Returns the referenced feature.
 IFeature getFeature(IProgressMonitor monitor)
          Returns the referenced feature.
 
Methods inherited from class org.eclipse.update.core.model.IncludedFeatureReferenceModel
getMatch, getNL, getOS, getOSArch, getSearchLocation, getWS, isOptional, isOptional, setArch, setMatchingRule, setNL, setOS, setSearchLocation, setWS
 
Methods inherited from class org.eclipse.update.core.FeatureReference
getFeature, getName, getSite, getVersionedIdentifier, isPatch, setSite, setURL
 
Methods inherited from class org.eclipse.update.core.model.FeatureReferenceModel
equals, getFeatureIdentifier, getFeatureVersion, getLabel, getLabelNonLocalized, getPatch, getPropertyName, getSiteModel, getType, getURL, getURLString, resolve, setFeatureIdentifier, setFeatureVersion, setLabel, setPatch, setSiteModel, setType, setURLString, toString
 
Methods inherited from class org.eclipse.update.core.model.ModelObject
arrayTypeFor, arrayTypeFor, assertIsWriteable, getResourceBundle, 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.IIncludedFeatureReference
getMatch, getSearchLocation, isOptional
 
Methods inherited from interface org.eclipse.update.core.IFeatureReference
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
 

Constructor Detail

IncludedFeatureReference

public IncludedFeatureReference()
Construct a included feature reference
Since:
2.1

IncludedFeatureReference

public IncludedFeatureReference(IIncludedFeatureReference includedFeatureRef)
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

IncludedFeatureReference

public IncludedFeatureReference(IFeatureReference featureReference)
Constructor IncludedFeatureReference.
Parameters:
iFeatureReference -  
Method Detail

getFeature

public IFeature getFeature(boolean perfectMatch,
                           org.eclipse.update.configuration.IConfiguredSite configuredSite)
                    throws CoreException
Deprecated.  

Description copied from interface: IIncludedFeatureReference
Returns the referenced feature. This is a factory method that creates the full feature object.
Specified by:
getFeature in interface IIncludedFeatureReference
See Also:
IIncludedFeatureReference.getFeature(boolean, IConfiguredSite)

getFeature

public IFeature getFeature(boolean perfectMatch,
                           org.eclipse.update.configuration.IConfiguredSite configuredSite,
                           IProgressMonitor monitor)
                    throws CoreException
Description copied from interface: IIncludedFeatureReference
Returns the referenced feature. This is a factory method that creates the full feature object.
Specified by:
getFeature in interface IIncludedFeatureReference
See Also:
IIncludedFeatureReference.getFeature(boolean, IConfiguredSite,IProgressMonitor)

getFeature

public IFeature getFeature()
                    throws CoreException
Deprecated.  

Description copied from interface: IIncludedFeatureReference
Returns the referenced feature. This is a factory method that creates the full feature object. equivalent to getFeature(false,null);
Specified by:
getFeature in interface IIncludedFeatureReference
Overrides:
getFeature in class FeatureReference
See Also:
IFeatureReference.getFeature()

getFeature

public IFeature getFeature(IProgressMonitor monitor)
                    throws CoreException
Description copied from interface: IFeatureReference
Returns the referenced feature. This is a factory method that creates the full feature object.
Specified by:
getFeature in interface IFeatureReference
Overrides:
getFeature in class FeatureReference
See Also:
(IProgressMonitor)

Eclipse Platform
2.1

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