org.eclipse.equinox.internal.p2.updatesite

Class SiteCategory

java.lang.Object

org.eclipse.equinox.internal.p2.updatesite.SiteCategory

public class SiteCategory
extends java.lang.Object

A category in an update site. Based on org.eclipse.update.core.model.CategoryModel.

Constructor Summary

Constructors

Constructor and Description
SiteCategory() Creates an uninitialized 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 obj) Compare two category models for equality.
java.lang.String[]	getCategoryNames() Returns the names of categories the referenced feature belongs to.
static java.util.Comparator<SiteCategory>	getComparator() Returns a comparator for category models.
java.lang.String	getDescription() Retrieve the detailed category description
java.lang.String	getLabel() Retrieve the non-localized displayable label for the category.
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.lang.String	getName() Retrieve the name of the category.
int	hashCode() Compute hash code for category model.
void	resolve(java.net.URL base, java.net.URL bundleURL) Resolve the model object.
void	setDescription(java.lang.String description) Sets the category description.
void	setLabel(java.lang.String label) Sets the category displayable label.
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	setName(java.lang.String name) Sets the category name.

Methods inherited from class java.lang.Object

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

Constructor Detail

SiteCategory

public SiteCategory()

Creates an uninitialized model object.

Since:

2.0

Method Detail

getComparator

public static java.util.Comparator<SiteCategory> getComparator()

Returns a comparator for category models.

Returns:

comparator

Since:

2.0

equals

public boolean equals(java.lang.Object obj)

Compare two category models for equality.

Overrides:

equals in class java.lang.Object

Since:

2.0

See Also:

Object.equals(Object)

getDescription

public java.lang.String getDescription()

Retrieve the detailed category description

Returns:

category description, or null.

Since:

2.0

getLabel

public java.lang.String getLabel()

Retrieve the non-localized displayable label for the category.

Returns:

non-localized displayable label, or null.

Since:

2.0

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

getName

public java.lang.String getName()

Retrieve the name of the category.

Returns:

category name, or null.

Since:

2.0

hashCode

public int hashCode()

Compute hash code for category model.

Overrides:

hashCode in class java.lang.Object

Since:

2.0

See Also:

Object.hashCode()

resolve

public void resolve(java.net.URL base,
                    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:

base - URL

bundleURL - resource bundle URL

Throws:

java.net.MalformedURLException

Since:

2.0

setDescription

public void setDescription(java.lang.String description)

Sets the category description. Throws a runtime exception if this object is marked read-only.

Parameters:

description - category description

Since:

2.0

setLabel

public void setLabel(java.lang.String label)

Sets the category displayable label. Throws a runtime exception if this object is marked read-only.

Parameters:

label - displayable label, or resource key

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

setName

public void setName(java.lang.String name)

Sets the category name. Throws a runtime exception if this object is marked read-only.

Parameters:

name - category name

Since:

2.0

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

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.