|
Eclipse Platform 2.1 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.eclipse.core.runtime.PlatformObject | +--org.eclipse.update.core.model.ModelObject | +--org.eclipse.update.core.model.FeatureModel
Feature 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.
Feature
Constructor Summary | |
FeatureModel()
Creates an uninitialized feature object. |
Method Summary | |
void |
addDiscoverySiteEntryModel(URLEntryModel discoverySiteInfo)
Adds an additional update site reference. |
void |
addImportModel(ImportModel importEntry)
Adds a plug-in dependency entry. |
void |
addIncludedFeatureReferenceModel(IncludedFeatureReferenceModel include)
Adds a feature identifier. |
void |
addNonPluginEntryModel(NonPluginEntryModel nonPluginEntry)
Adds a non-plug-in data reference. |
void |
addPluginEntryModel(PluginEntryModel pluginEntry)
Adds a plug-in reference. |
boolean |
equals(Object obj)
Compares 2 feature models for equality |
String |
getAffinityFeature()
Returns an optional identifier for the colocation affinity feature |
String |
getApplication()
Returns an optional identifier for the feature application |
URLEntryModel |
getCopyrightModel()
Returns the copyright information for the feature. |
URLEntryModel |
getDescriptionModel()
Returns the feature description. |
URLEntryModel[] |
getDiscoverySiteEntryModels()
Return an array of information entries referencing locations of other update sites. |
String |
getFeatureIdentifier()
Returns the feature identifier as a string |
IIncludedFeatureReference[] |
getFeatureIncluded()
Returns an array of included feature reference model referenced by this feature. |
VersionedIdentifier[] |
getFeatureIncludeVersionedIdentifier()
Deprecated. use getFeatureIncludeIdentifier instead. |
String |
getFeatureVersion()
Returns the feature version as a string |
URL |
getImageURL()
Returns the resolved URL for the image. |
String |
getImageURLString()
Returns the unresolved URL string for the feature image. |
ImportModel[] |
getImportModels()
Return a list of plug-in dependencies for this feature. |
InstallHandlerEntryModel |
getInstallHandlerModel()
Returns and optional custom install handler entry. |
String |
getLabel()
Retrieve the displayable label for the feature. |
String |
getLabelNonLocalized()
Retrieve the non-localized displayable label for the feature. |
URLEntryModel |
getLicenseModel()
Returns the license information for the feature. |
String |
getNL()
Get optional locale specification as a comma-separated string. |
NonPluginEntryModel[] |
getNonPluginEntryModels()
Returns an array of non-plug-in entries referenced by this feature |
String |
getOS()
Get optional operating system specification as a comma-separated string. |
String |
getOSArch()
Get optional system architecture specification as a comma-separated string. |
PluginEntryModel[] |
getPluginEntryModels()
Returns an array of plug-in entries referenced by this feature |
String |
getPrimaryPluginID()
Returns the primaryPluginID. |
String |
getProvider()
Retrieve the displayable label for the feature provider. |
String |
getProviderNonLocalized()
Retrieve the non-localized displayable label for the feature provider. |
URLEntryModel |
getUpdateSiteEntryModel()
Returns an information entry referencing the location of the feature update site. |
String |
getWS()
Get optional windowing system specification as a comma-separated string. |
boolean |
isExclusive()
Indicates whether the feature must be processed alone during installation and configuration. |
boolean |
isPatch()
Returns true if this feature is patching another feature,
false otherwise |
boolean |
isPrimary()
Indicates whether the feature can be used as a primary feature. |
void |
markReadOnly()
Marks the model object as read-only. |
void |
removeDiscoverySiteEntryModel(URLEntryModel discoverySiteInfo)
Removes an update site reference. |
void |
removeImportModel(ImportModel importEntry)
Removes a plug-in dependency entry. |
void |
removeNonPluginEntryModel(NonPluginEntryModel nonPluginEntry)
Removes a non-plug-in data reference. |
void |
removePluginEntryModel(PluginEntryModel pluginEntry)
Removes a plug-in reference. |
void |
resolve(URL base,
URL bundleURL)
Resolve the model object. |
void |
setAffinityFeature(String affinity)
Sets the identifier of the Feature this feature should be installed with. |
void |
setApplication(String application)
Sets the feature application identifier. |
void |
setArch(String arch)
Sets the system architecture specification. |
void |
setCopyrightModel(URLEntryModel copyright)
Sets the feature copyright information. |
void |
setDescriptionModel(URLEntryModel description)
Sets the feature description information. |
void |
setDiscoverySiteEntryModels(URLEntryModel[] discoverySiteInfo)
Sets additional update site references. |
void |
setExclusive(boolean exclusive)
Indicates whether this feature can act as a primary feature. |
void |
setFeatureIdentifier(String featureId)
Sets the feature identifier. |
void |
setFeatureVersion(String featureVersion)
Sets the feature version. |
void |
setImageURLString(String imageURLString)
Sets the unresolved URL for the feature image. |
void |
setImportModels(ImportModel[] imports)
Sets the feature plug-in dependency information. |
void |
setInstallHandlerModel(InstallHandlerEntryModel installHandler)
Sets the custom install handler for the feature. |
void |
setLabel(String label)
Sets the feature displayable label. |
void |
setLicenseModel(URLEntryModel license)
Sets the feature license information. |
void |
setNL(String nl)
Sets the locale specification. |
void |
setNonPluginEntryModels(NonPluginEntryModel[] nonPluginEntries)
Sets the feature non-plug-in data references. |
void |
setOS(String os)
Sets the operating system specification. |
void |
setPluginEntryModels(PluginEntryModel[] pluginEntries)
Sets the feature plug-in references. |
void |
setPrimary(boolean primary)
Indicates whether this feature can act as a primary feature. |
void |
setPrimaryPluginID(String plugin)
Method setPrimaryPlugin. |
void |
setProvider(String provider)
Sets the feature provider displayable label. |
void |
setUpdateSiteEntryModel(URLEntryModel updateSiteInfo)
Sets the feature update site reference. |
void |
setWS(String ws)
Sets the windowing system specification. |
Methods inherited from class org.eclipse.update.core.model.ModelObject |
arrayTypeFor, arrayTypeFor, assertIsWriteable, getPropertyName, getResourceBundle, isReadOnly, markListReferenceReadOnly, 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, toString, wait, wait, wait |
Constructor Detail |
public FeatureModel()
Method Detail |
public boolean equals(Object obj)
equals
in class Object
obj
- feature model to compare withtrue
if the two models are equal,
false
otherwisepublic String getFeatureIdentifier()
IFeature.getVersionedIdentifier()
public String getFeatureVersion()
IFeature.getVersionedIdentifier()
public String getLabel()
null
.public String getLabelNonLocalized()
null
.public String getProvider()
null
.public String getProviderNonLocalized()
null
.public String getImageURLString()
null
public URL getImageURL()
null
public String getOS()
null
.BootLoader
public String getWS()
null
.BootLoader
public String getOSArch()
null
.BootLoader
public String getNL()
null
.public boolean isPrimary()
true
if this is a primary feature,
otherwise false
public boolean isExclusive()
true
if feature requires
exclusive processing, false
otherwise.public String getApplication()
null
.public String getAffinityFeature()
null
.public InstallHandlerEntryModel getInstallHandlerModel()
null
if
none was specifiedpublic URLEntryModel getDescriptionModel()
null
.public URLEntryModel getCopyrightModel()
null
.public URLEntryModel getLicenseModel()
null
.public URLEntryModel getUpdateSiteEntryModel()
null
.public URLEntryModel[] getDiscoverySiteEntryModels()
public ImportModel[] getImportModels()
public PluginEntryModel[] getPluginEntryModels()
public VersionedIdentifier[] getFeatureIncludeVersionedIdentifier()
public IIncludedFeatureReference[] getFeatureIncluded()
public NonPluginEntryModel[] getNonPluginEntryModels()
public void setFeatureIdentifier(String featureId)
featureId
- feature identifierpublic void setFeatureVersion(String featureVersion)
featureVersion
- feature versionpublic void setLabel(String label)
label
- displayable labelpublic void setProvider(String provider)
provider
- provider displayable labelpublic void setImageURLString(String imageURLString)
imageURLString
- unresolved URL stringpublic void setOS(String os)
os
- operating system specification as a comma-separated listBootLoader
public void setWS(String ws)
ws
- windowing system specification as a comma-separated listBootLoader
public void setNL(String nl)
nl
- locale specification as a comma-separated listpublic void setArch(String arch)
arch
- system architecture specification as a comma-separated listBootLoader
public void setPrimary(boolean primary)
primary
- true
if this feature can act as primary,
false
otherwisepublic void setExclusive(boolean exclusive)
exclusive
- true
if this feature must be
processed independently from other features, false
if feature can be processed in a batch with other features.public void setApplication(String application)
application
- feature application identifierpublic void setAffinityFeature(String affinity)
affinity
- the identifier of the Featurepublic void setInstallHandlerModel(InstallHandlerEntryModel installHandler)
installHandler
- install handler entrypublic void setDescriptionModel(URLEntryModel description)
description
- feature description informationpublic void setCopyrightModel(URLEntryModel copyright)
copyright
- feature copyright informationpublic void setLicenseModel(URLEntryModel license)
license
- feature license informationpublic void setUpdateSiteEntryModel(URLEntryModel updateSiteInfo)
updateSiteInfo
- feature update site referencepublic void setDiscoverySiteEntryModels(URLEntryModel[] discoverySiteInfo)
discoverySiteInfo
- additional update site referencespublic void setImportModels(ImportModel[] imports)
imports
- feature plug-in dependency informationpublic void setPluginEntryModels(PluginEntryModel[] pluginEntries)
pluginEntries
- feature plug-in referencespublic void setNonPluginEntryModels(NonPluginEntryModel[] nonPluginEntries)
nonPluginEntries
- feature non-plug-in data referencespublic void addDiscoverySiteEntryModel(URLEntryModel discoverySiteInfo)
discoverySiteInfo
- update site referencepublic void addImportModel(ImportModel importEntry)
importEntry
- plug-in dependency entrypublic void addPluginEntryModel(PluginEntryModel pluginEntry)
pluginEntry
- plug-in referencepublic void addIncludedFeatureReferenceModel(IncludedFeatureReferenceModel include)
identifier
- feature identiferoptions
- the options associated with the nested featurepublic void addNonPluginEntryModel(NonPluginEntryModel nonPluginEntry)
nonPluginEntry
- non-plug-in data referencepublic void removeDiscoverySiteEntryModel(URLEntryModel discoverySiteInfo)
discoverySiteInfo
- update site referencepublic void removeImportModel(ImportModel importEntry)
importEntry
- plug-in dependency entrypublic void removePluginEntryModel(PluginEntryModel pluginEntry)
pluginEntry
- plug-in referencepublic void removeNonPluginEntryModel(NonPluginEntryModel nonPluginEntry)
nonPluginEntry
- non-plug-in data referencepublic void markReadOnly()
markReadOnly
in class ModelObject
public void resolve(URL base, URL bundleURL) throws MalformedURLException
resolve
in class ModelObject
base
- URLbundle
- resource bundleMalformedURLException
- public void setPrimaryPluginID(String plugin)
plugin
- public String getPrimaryPluginID()
public boolean isPatch()
true
if this feature is patching another feature,
false
otherwise
|
Eclipse Platform 2.1 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |