org.hippoecm.repository.api

Class Localized

java.lang.Object

org.hippoecm.repository.api.Localized

All Implemented Interfaces:

Serializable

public final class Localized
extends Object
implements Serializable

The Localized object is a more generic form of the Locale object, but serves a similar purpose. Where the Locale object can only handle language, country and region and only if specified in that exact order, the Localized object can also indicate a locale on other factors. Such as on live or preview site, or when a translation is based only upon country regardless of language.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
static Localized	getInstance() A default non-specific localized object
static Localized	getInstance(Locale locale) Obtain a Localized object for the specified locale
static Localized	getInstance(Map<String,List<String>> locales) Obtain a Localized object for the specified locales
static Localized	getInstance(javax.jcr.Node node) Gets an instance of Localized where the parameter indicates a translation from which to form the localized object.
Locale	getLocale() Returns the Locale object if available and if the Locale object holds enough information to specify a translation.
int	hashCode()
Localized	matches(Localized candidate1, Localized candidate2) DO NOT USE THIS METHOD IS NOT PART OF THE PUBLIC API
void	setTranslation(javax.jcr.Node node) DO NOT USE THIS METHOD IS NOT PART OF THE PUBLIC API.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static Localized getInstance()

A default non-specific localized object

Returns:

a Localized object without any specification such or language or region to base a translation upon

getInstance

public static Localized getInstance(Locale locale)

Obtain a Localized object for the specified locale

Parameters:

locale - the Locale to base the Localized object on

Returns:

the Localized object

getInstance

public static Localized getInstance(Map<String,List<String>> locales)

Obtain a Localized object for the specified locales

Parameters:

locales -

Returns:

the Localized object

getLocale

public Locale getLocale()

Returns the Locale object if available and if the Locale object holds enough information to specify a translation.

Returns:

returns a plain locale object, if available or null otherwise

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

matches

public Localized matches(Localized candidate1,
                         Localized candidate2)

DO NOT USE THIS METHOD IS NOT PART OF THE PUBLIC API

getInstance

public static Localized getInstance(javax.jcr.Node node)
                             throws javax.jcr.RepositoryException

Gets an instance of Localized where the parameter indicates a translation from which to form the localized object. I.e. if the node is a translation node for the english translation, then the returned Localized object specifies the english locale.

Parameters:

node - the translation for which to return the Localized object

Returns:

the Localized object, or null if not available

Throws:

javax.jcr.RepositoryException

setTranslation

public void setTranslation(javax.jcr.Node node)
                    throws javax.jcr.RepositoryException

DO NOT USE THIS METHOD IS NOT PART OF THE PUBLIC API.

Throws:

javax.jcr.RepositoryException

toString

public String toString()

Overrides:

toString in class Object