org.eclipse.equinox.internal.p2.updatesite

Class SiteFeature

java.lang.Object

org.eclipse.equinox.internal.p2.updatesite.SiteFeature

public class SiteFeature
extends java.lang.Object

A reference to a feature in an update site.xml file. Based on org.eclipse.update.core.model.FeatureReferenceModel.

Constructor Summary

Constructors

Constructor and Description
SiteFeature() Creates an uninitialized feature reference model object.

Method Summary

Modifier and Type	Method and Description
void	addCategoryName(java.lang.String categoryName) Adds the name of a category this feature belongs to.
boolean	equals(java.lang.Object object) Compares 2 feature reference models for equality
java.lang.String[]	getCategoryNames() Returns the names of categories the referenced feature belongs to.
java.lang.String	getFeatureIdentifier() Returns the feature identifier as a string
java.lang.String	getFeatureVersion() Returns the feature version as a string
java.lang.String	getLabel() Retrieve the displayable label for the feature reference.
java.lang.String	getLabelNonLocalized() Retrieve the non-localized displayable label for the feature reference.
java.lang.String	getNL() Get optional locale specification as a comma-separated string.
java.lang.String	getOS() Get optional operating system specification as a comma-separated string.
java.lang.String	getOSArch() Get optional system architecture specification as a comma-separated string.
java.lang.String	getPatch() Returns the patch mode.
SiteModel	getSiteModel() Returns the site model for the reference.
java.lang.String	getType() Returns the referenced feature type.
java.net.URL	getURL() Returns the resolved URL for the feature reference.
java.lang.String	getURLString() Returns the unresolved URL string for the reference.
java.lang.String	getWS() Get optional windowing system specification as a comma-separated string.
int	hashCode()
void	resolve(java.net.URL resolveBase, java.net.URL bundleURL) Resolve the model object.
static boolean	sameURL(java.net.URL url1, java.net.URL url2)
void	setArch(java.lang.String arch) Sets the system architecture specification.
void	setCategoryNames(java.lang.String[] categoryNames) Sets the names of categories this feature belongs to.
void	setFeatureIdentifier(java.lang.String featureId) Sets the feature identifier.
void	setFeatureVersion(java.lang.String featureVersion) Sets the feature version.
void	setLabel(java.lang.String label) Sets the label.
void	setNL(java.lang.String nl) Sets the locale specification.
void	setOS(java.lang.String os) Sets the operating system specification.
void	setPatch(java.lang.String patch) Sets the patch mode.
void	setSiteModel(SiteModel site) Sets the site for the referenced.
void	setType(java.lang.String type) Sets the referenced feature type.
void	setURLString(java.lang.String urlString) Sets the unresolved URL for the feature reference.
void	setWS(java.lang.String ws) Sets the windowing system specification.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SiteFeature

public SiteFeature()

Creates an uninitialized feature reference model object.

Method Detail

sameURL

public static boolean sameURL(java.net.URL url1,
                              java.net.URL url2)

addCategoryName

public void addCategoryName(java.lang.String categoryName)

Adds the name of a category this feature belongs to. Throws a runtime exception if this object is marked read-only.

Parameters:

categoryName - category name

equals

public boolean equals(java.lang.Object object)

Compares 2 feature reference models for equality

Overrides:

equals in class java.lang.Object

Parameters:

object - feature reference model to compare with

Returns:

true if the two models are equal, false otherwise

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getCategoryNames

public java.lang.String[] getCategoryNames()

Returns the names of categories the referenced feature belongs to.

Returns:

an array of names, or an empty array.

getFeatureIdentifier

public java.lang.String getFeatureIdentifier()

Returns the feature identifier as a string

Returns:

feature identifier

getFeatureVersion

public java.lang.String getFeatureVersion()

Returns the feature version as a string

Returns:

feature version

getLabel

public java.lang.String getLabel()

Retrieve the displayable label for the feature reference. If the model object has been resolved, the label is localized.

Returns:

displayable label, or null.

getLabelNonLocalized

public java.lang.String getLabelNonLocalized()

Retrieve the non-localized displayable label for the feature reference.

Returns:

non-localized displayable label, or null.

getNL

public java.lang.String getNL()

Get optional locale specification as a comma-separated string.

Returns:

the locale specification string, or null.

getOS

public java.lang.String getOS()

Get optional operating system specification as a comma-separated string.

Returns:

the operating system specification string, or null.

getOSArch

public java.lang.String getOSArch()

Get optional system architecture specification as a comma-separated string.

Returns:

the system architecture specification string, or null.

getPatch

public java.lang.String getPatch()

Returns the patch mode.

getSiteModel

public SiteModel getSiteModel()

Returns the site model for the reference.

Returns:

site model

Since:

2.0

getType

public java.lang.String getType()

Returns the referenced feature type.

Returns:

feature type, or null representing the default feature type for the site

getURL

public java.net.URL getURL()

Returns the resolved URL for the feature reference.

Returns:

url string

getURLString

public java.lang.String getURLString()

Returns the unresolved URL string for the reference.

Returns:

url string

getWS

public java.lang.String getWS()

Get optional windowing system specification as a comma-separated string.

Returns:

the windowing system specification string, or null.

resolve

public void resolve(java.net.URL resolveBase,
                    java.net.URL bundleURL)
             throws java.net.MalformedURLException

Resolve the model object. Any URL strings in the model are resolved relative to the base URL argument. Any translatable strings in the model that are specified as translation keys are localized using the supplied resource bundle.

Parameters:

resolveBase - URL

bundleURL - resource bundle URL

Throws:

java.net.MalformedURLException

setArch

public void setArch(java.lang.String arch)

Sets the system architecture specification. Throws a runtime exception if this object is marked read-only.

Parameters:

arch - system architecture specification as a comma-separated list

setCategoryNames

public void setCategoryNames(java.lang.String[] categoryNames)

Sets the names of categories this feature belongs to. Throws a runtime exception if this object is marked read-only.

Parameters:

categoryNames - an array of category names

setFeatureIdentifier

public void setFeatureIdentifier(java.lang.String featureId)

Sets the feature identifier. Throws a runtime exception if this object is marked read-only.

Parameters:

featureId - feature identifier

setFeatureVersion

public void setFeatureVersion(java.lang.String featureVersion)

Sets the feature version. Throws a runtime exception if this object is marked read-only.

Parameters:

featureVersion - feature version

setLabel

public void setLabel(java.lang.String label)

Sets the label.

Parameters:

label - The label to set

setNL

public void setNL(java.lang.String nl)

Sets the locale specification. Throws a runtime exception if this object is marked read-only.

Parameters:

nl - locale specification as a comma-separated list

setOS

public void setOS(java.lang.String os)

Sets the operating system specification. Throws a runtime exception if this object is marked read-only.

Parameters:

os - operating system specification as a comma-separated list

setPatch

public void setPatch(java.lang.String patch)

Sets the patch mode.

setSiteModel

public void setSiteModel(SiteModel site)

Sets the site for the referenced. Throws a runtime exception if this object is marked read-only.

Parameters:

site - site for the reference

setType

public void setType(java.lang.String type)

Sets the referenced feature type. Throws a runtime exception if this object is marked read-only.

Parameters:

type - referenced feature type

setURLString

public void setURLString(java.lang.String urlString)

Sets the unresolved URL for the feature reference. Throws a runtime exception if this object is marked read-only.

Parameters:

urlString - unresolved URL string

setWS

public void setWS(java.lang.String ws)

Sets the windowing system specification. Throws a runtime exception if this object is marked read-only.

Parameters:

ws - windowing system specification as a comma-separated list

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()