org.eclipse.equinox.internal.p2.updatesite

Class SiteModel

java.lang.Object

org.eclipse.equinox.internal.p2.updatesite.SiteModel

public class SiteModel
extends java.lang.Object

A model of an update site. Copied from org.eclipse.update.core.model.SiteModel.

Constructor Summary

Constructors

Constructor and Description
SiteModel() Creates an uninitialized site model object.

Method Summary

Modifier and Type	Method and Description
void	addArchive(URLEntry archiveReference) Adds an archive reference model to site.
void	addBundle(SiteBundle bundleReference) Adds a bundle reference model to site.
void	addCategory(SiteCategory category) Adds a category to the site.
void	addFeature(SiteFeature featureReference) Adds a feature reference model to site.
void	addIU(SiteIU iu) Adds a iu model to site.
void	addRepositoryReference(RepositoryReference ref) Adds a repository reference to the site
void	addStatsBundle(SiteBundle bundleReference) Adds a bundle reference model to site stats artifacts
void	addStatsFeature(SiteFeature featureReference) Adds a feature reference model to site stats artifacts.
URLEntry[]	getArchives() Returns an array of plug-in and non-plug-in archive reference models on this site
URLEntry[]	getAssociatedSites()
SiteBundle[]	getBundles() Returns an array of bundle reference models on this site.
SiteCategory[]	getCategories() Returns an array of category models for this site.
SiteCategory	getCategory(java.lang.String name) Returns the category with the given name.
URLEntry	getDescription() Returns the site description.
java.lang.String	getDigestURIString()
SiteFeature[]	getFeatures() Returns an array of feature reference models on this site.
SiteIU[]	getIUs() Returns an array of IU models on this site.
java.util.Map<java.util.Locale,java.util.Map<java.lang.String,java.lang.String>>	getLocalizations() Gets the localizations for the site as a map from locale to the set of translated properties for that locale.
java.net.URI	getLocationURI() Returns the resolved URI for the site.
java.lang.String	getLocationURIString() Returns the unresolved URI string for the site.
java.util.List<java.lang.String>	getMessageKeys() Return the keys for translatable strings
java.lang.String	getMirrorsURI() Returns the URI from which the list of mirrors of this site can be retrieved.
RepositoryReference[]	getRepositoryReferences() Returns an array of repository references for this site.
SiteBundle[]	getStatsBundles() Returns an array of bundle reference models for stats on this site.
SiteFeature[]	getStatsFeatures() Returns an array of feature reference models for stats on this site.
java.lang.String	getStatsURI() Returns the URI of the stats repository that tracks downloads.
java.lang.String	getType() Returns the site type.
boolean	isPack200Supported()
void	setAssociateSites(URLEntry[] associateSites) Sets the associated sites for this update site.
void	setDescription(URLEntry description) Sets the site description.
void	setDigestURIString(java.lang.String digestURIString)
void	setLocalizations(java.util.Map<java.util.Locale,java.util.Map<java.lang.String,java.lang.String>> localizations) Sets the localizations for the site as a map from locale to the set of translated properties for that locale.
void	setLocationURIString(java.lang.String locationURIString) Sets the unresolved URI for the site.
void	setMessageKeys(java.util.List<java.lang.String> keys) Sets keys for translatable strings
void	setMirrorsURIString(java.lang.String mirrorsURI) Sets the mirrors url.
void	setStatsURIString(java.lang.String statsURI) Sets the URI of the stats repository used to track downloads.
void	setSupportsPack200(boolean value)
void	setType(java.lang.String type) Sets the site type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SiteModel

public SiteModel()

Creates an uninitialized site model object.

Since:

2.0

Method Detail

addArchive

public void addArchive(URLEntry archiveReference)

Adds an archive reference model to site. Throws a runtime exception if this object is marked read-only.

Parameters:

archiveReference - archive reference model

Since:

2.0

addCategory

public void addCategory(SiteCategory category)

Adds a category to the site.

Parameters:

category - category model

addFeature

public void addFeature(SiteFeature featureReference)

Adds a feature reference model to site.

Parameters:

featureReference - feature reference model

addBundle

public void addBundle(SiteBundle bundleReference)

Adds a bundle reference model to site.

Parameters:

bundleReference - bundle reference model

addStatsFeature

public void addStatsFeature(SiteFeature featureReference)

Adds a feature reference model to site stats artifacts.

Parameters:

featureReference - feature reference model

addStatsBundle

public void addStatsBundle(SiteBundle bundleReference)

Adds a bundle reference model to site stats artifacts

Parameters:

bundleReference - bundle reference model

addIU

public void addIU(SiteIU iu)

Adds a iu model to site.

Parameters:

iu - iu model

addRepositoryReference

public void addRepositoryReference(RepositoryReference ref)

Adds a repository reference to the site

Parameters:

ref - repository reference

getArchives

public URLEntry[] getArchives()

Returns an array of plug-in and non-plug-in archive reference models on this site

Returns:

an array of archive reference models, or an empty array if there are no archives known to this site.

Since:

2.0

getAssociatedSites

public URLEntry[] getAssociatedSites()

getCategories

public SiteCategory[] getCategories()

Returns an array of category models for this site.

Returns:

array of site category models, or an empty array.

Since:

2.0

getCategory

public SiteCategory getCategory(java.lang.String name)

Returns the category with the given name.

Returns:

the category with the given name, or null

getDescription

public URLEntry getDescription()

Returns the site description.

Returns:

site description, or null.

getFeatures

public SiteFeature[] getFeatures()

Returns an array of feature reference models on this site.

Returns:

an array of feature reference models, or an empty array.

getBundles

public SiteBundle[] getBundles()

Returns an array of bundle reference models on this site.

Returns:

an array of bundle reference models, or an empty array.

getStatsFeatures

public SiteFeature[] getStatsFeatures()

Returns an array of feature reference models for stats on this site.

Returns:

an array of feature reference models, or an empty array.

getStatsBundles

public SiteBundle[] getStatsBundles()

Returns an array of bundle reference models for stats on this site.

Returns:

an array of bundle reference models, or an empty array.

getIUs

public SiteIU[] getIUs()

Returns an array of IU models on this site.

Returns:

an array of IU models, or an empty array.

getRepositoryReferences

public RepositoryReference[] getRepositoryReferences()

Returns an array of repository references for this site.

Returns:

an array of repository references, or an empty array.

getStatsURI

public java.lang.String getStatsURI()

Returns the URI of the stats repository that tracks downloads.

Returns:

a String representation of the stats URI.

getLocalizations

public java.util.Map<java.util.Locale,java.util.Map<java.lang.String,java.lang.String>> getLocalizations()

Gets the localizations for the site as a map from locale to the set of translated properties for that locale.

Returns:

a map from locale to property set

Since:

3.4

getLocationURI

public java.net.URI getLocationURI()

Returns the resolved URI for the site.

Returns:

url, or null

getLocationURIString

public java.lang.String getLocationURIString()

Returns the unresolved URI string for the site.

Returns:

url string, or null

getMessageKeys

public java.util.List<java.lang.String> getMessageKeys()

Return the keys for translatable strings

Returns:

the list of keys for translatable strings; may be null

Since:

3.4

getMirrorsURI

public java.lang.String getMirrorsURI()

Returns the URI from which the list of mirrors of this site can be retrieved.

getType

public java.lang.String getType()

Returns the site type.

Returns:

site type, or null.

Since:

2.0

isPack200Supported

public boolean isPack200Supported()

setDescription

public void setDescription(URLEntry description)

Sets the site description.

Parameters:

description - site description

Since:

2.0

setLocalizations

public void setLocalizations(java.util.Map<java.util.Locale,java.util.Map<java.lang.String,java.lang.String>> localizations)

Sets the localizations for the site as a map from locale to the set of translated properties for that locale.

Parameters:

localizations - as a map from locale to property set

Since:

3.4

setLocationURIString

public void setLocationURIString(java.lang.String locationURIString)

Sets the unresolved URI for the site.

Parameters:

locationURIString - url for the site (as a string)

Since:

2.0

setMessageKeys

public void setMessageKeys(java.util.List<java.lang.String> keys)

Sets keys for translatable strings

Parameters:

keys - for translatable strings

Since:

3.4

setMirrorsURIString

public void setMirrorsURIString(java.lang.String mirrorsURI)

Sets the mirrors url. Mirror sites will then be obtained from this mirror url later. This method is complementary to setMirrorsiteEntryModels(), and only one of these methods should be called.

Parameters:

mirrorsURI - additional update site mirrors

Since:

3.1

setSupportsPack200

public void setSupportsPack200(boolean value)

setType

public void setType(java.lang.String type)

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

Parameters:

type - site type

Since:

2.0

setAssociateSites

public void setAssociateSites(URLEntry[] associateSites)

Sets the associated sites for this update site.

Parameters:

associateSites - the associated sites

setDigestURIString

public void setDigestURIString(java.lang.String digestURIString)

getDigestURIString

public java.lang.String getDigestURIString()

setStatsURIString

public void setStatsURIString(java.lang.String statsURI)

Sets the URI of the stats repository used to track downloads.

Parameters:

statsURI - a String describing the stats URI