Eclipse Platform
2.1

org.eclipse.update.core.model
Class IncludedFeatureReferenceModel

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
All Implemented Interfaces:
IAdaptable, IFeatureReference, IPlatformEnvironment
Direct Known Subclasses:
IncludedFeatureReference

public class IncludedFeatureReferenceModel
extends FeatureReference

Included Feature reference model object.

This class may be instantiated or subclassed by clients. However, in most cases clients should instead instantiate or subclass the provided concrete implementation of this model.

Since:
2.1
See Also:
IncludedFeatureReference

Constructor Summary
IncludedFeatureReferenceModel()
          Construct a included feature reference
IncludedFeatureReferenceModel(IFeatureReference featureReference)
          Constructor IncludedFeatureReferenceModel.
IncludedFeatureReferenceModel(IncludedFeatureReferenceModel includedFeatureRef)
          Construct a included feature reference model
 
Method Summary
 int getMatch()
          Returns the matching rule for this included feature.
 String getNL()
          Returns the nl.
 String getOS()
          Returns the os.
 String getOSArch()
          Returns the arch.
 int getSearchLocation()
          Returns the search location for this included feature.
 String getWS()
          Returns the ws.
 boolean isOptional()
          Returns the isOptional
 void isOptional(boolean isOptional)
          Sets the isOptional.
 void setArch(String arch)
          Sets the arch.
 void setMatchingRule(int matchingRule)
          Sets the matchingRule.
 void setNL(String nl)
          Sets the nl.
 void setOS(String os)
          Sets the os.
 void setSearchLocation(int searchLocation)
          Sets the searchLocation.
 void setWS(String ws)
          Sets the ws.
 
Methods inherited from class org.eclipse.update.core.FeatureReference
getFeature, getFeature, 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.IFeatureReference
getURL
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 

Constructor Detail

IncludedFeatureReferenceModel

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

IncludedFeatureReferenceModel

public IncludedFeatureReferenceModel(IncludedFeatureReferenceModel includedFeatureRef)
Construct a included feature reference model
Parameters:
includedFeatureRef - the included reference model to copy
Since:
2.1

IncludedFeatureReferenceModel

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

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
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
Returns:
int representation of feature searching rule.
Since:
2.0.2
See Also:
IUpdateConstants.SEARCH_ROOT, IUpdateConstants.SEARCH_SELF

isOptional

public boolean isOptional()
Returns the isOptional
Returns:
isOptional
Since:
2.0.1

isOptional

public void isOptional(boolean isOptional)
Sets the isOptional.
Parameters:
isOptional - The isOptional to set

setMatchingRule

public void setMatchingRule(int matchingRule)
Sets the matchingRule.
Parameters:
matchingRule - The matchingRule to set

setSearchLocation

public void setSearchLocation(int searchLocation)
Sets the searchLocation.
Parameters:
searchLocation - The searchLocation to set

getOSArch

public String getOSArch()
Returns the arch.
Overrides:
getOSArch in class FeatureReference
Returns:
String

getOS

public String getOS()
Returns the os.
Overrides:
getOS in class FeatureReference
Returns:
String

getWS

public String getWS()
Returns the ws.
Overrides:
getWS in class FeatureReference
Returns:
String

setArch

public void setArch(String arch)
Sets the arch.
Overrides:
setArch in class FeatureReferenceModel
Parameters:
arch - The arch to set

setOS

public void setOS(String os)
Sets the os.
Overrides:
setOS in class FeatureReferenceModel
Parameters:
os - The os to set

setWS

public void setWS(String ws)
Sets the ws.
Overrides:
setWS in class FeatureReferenceModel
Parameters:
ws - The ws to set

getNL

public String getNL()
Returns the nl.
Overrides:
getNL in class FeatureReference
Returns:
String

setNL

public void setNL(String nl)
Sets the nl.
Overrides:
setNL in class FeatureReferenceModel
Parameters:
nl - The nl to set

Eclipse Platform
2.1

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