org.eclipse.equinox.internal.p2.updatesite

Class SiteBundle

java.lang.Object

org.eclipse.equinox.internal.p2.updatesite.SiteBundle

public class SiteBundle
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
SiteBundle() Creates an uninitialized bundle reference model object.

Method Summary

Modifier and Type	Method and Description
void	addCategoryName(java.lang.String categoryName) Adds the name of a category this bundle belongs to.
boolean	equals(java.lang.Object object) Compares 2 bundle reference models for equality
java.lang.String	getBundleIdentifier() Returns the bundle identifier as a string
java.lang.String	getBundleVersion() Returns the bundle version as a string
java.lang.String[]	getCategoryNames() Returns the names of categories the referenced bundle belongs to.
java.lang.String	getLabel() Retrieve the displayable label for the bundle reference.
java.lang.String	getLabelNonLocalized() Retrieve the non-localized displayable label for the bundle 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 bundle type.
java.net.URL	getURL() Returns the resolved URL for the bundle 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	setBundleIdentifier(java.lang.String bundleId) Sets the bundle identifier.
void	setBundleVersion(java.lang.String bundleVersion) Sets the bundle version.
void	setCategoryNames(java.lang.String[] categoryNames) Sets the names of categories this bundle belongs to.
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 bundle type.
void	setURLString(java.lang.String urlString) Sets the unresolved URL for the bundle 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

SiteBundle

public SiteBundle()

Creates an uninitialized bundle 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 bundle 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 bundle reference models for equality

Overrides:

equals in class java.lang.Object

Parameters:

object - bundle 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 bundle belongs to.

Returns:

an array of names, or an empty array.

getBundleIdentifier

public java.lang.String getBundleIdentifier()

Returns the bundle identifier as a string

Returns:

bundle identifier

getBundleVersion

public java.lang.String getBundleVersion()

Returns the bundle version as a string

Returns:

bundle version

getLabel

public java.lang.String getLabel()

Retrieve the displayable label for the bundle 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 bundle 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 bundle type.

Returns:

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

getURL

public java.net.URL getURL()

Returns the resolved URL for the bundle 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 bundle belongs to. Throws a runtime exception if this object is marked read-only.

Parameters:

categoryNames - an array of category names

setBundleIdentifier

public void setBundleIdentifier(java.lang.String bundleId)

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

Parameters:

bundleId - bundle identifier

setBundleVersion

public void setBundleVersion(java.lang.String bundleVersion)

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

Parameters:

bundleVersion - bundle 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 bundle type. Throws a runtime exception if this object is marked read-only.

Parameters:

type - referenced bundle type

setURLString

public void setURLString(java.lang.String urlString)

Sets the unresolved URL for the bundle 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()