com.appiancorp.suiteapi.common

Class LocaleString

java.lang.Object

com.appiancorp.suiteapi.common.LocaleString

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public final class LocaleString
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

LocaleString LocaleString represents one String with representations in one or more Locales, or in all Locales (an insensitive String). This may be output or input as a single encoded String, using escapes.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LocaleString()
LocaleString(java.util.Locale locale, java.lang.String text)
LocaleString(java.lang.String overall)

Method Summary

Modifier and Type	Method and Description
LocaleString	clone() Clone this LocaleString; the result will have its own locale sensitive map.
boolean	containsLocale(java.util.Locale locale_)
boolean	equals(java.lang.Object obj)
java.lang.String	get(java.util.Locale locale)
java.lang.String	get(java.lang.String locale)
java.util.Set<java.util.Locale>	getLocales() Get the Locale keys for this LocaleString.
java.lang.String	getLocalizeExpressionString()
java.util.Set<java.lang.String>	getStringLocales()
int	hashCode()
boolean	isExpression()
void	put(java.util.Locale locale, java.lang.String text)
void	put(java.lang.String text)
void	put(java.lang.String locale, java.lang.String text)
java.lang.String	retrieveValueForLocaleOrFirstAvailable(java.util.Locale targetLocale) Returns the localized value for the given locale, if available.
java.lang.String	retrieveValueForUserLocaleOrPrimary(java.util.Locale userLocale, java.util.Locale primaryLocale) Returns the localized value for the user's locale, if available.
java.lang.String	retrieveValueForUserLocaleOrPrimary(java.util.Locale userLocale, SiteLocaleSettings sls) Deprecated. This method will be removed in a future release. Use retrieveValueForUserLocaleOrPrimary(Locale, Locale) instead.
java.lang.String	toEncodedString()
java.lang.String	toString() Returns a string representation of the given LocaleString object.

Methods inherited from class java.lang.Object

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

Constructor Detail

LocaleString

public LocaleString()

LocaleString

public LocaleString(java.util.Locale locale,
                    java.lang.String text)

LocaleString

public LocaleString(java.lang.String overall)

Method Detail

get

public final java.lang.String get(java.util.Locale locale)

get

public final java.lang.String get(java.lang.String locale)

retrieveValueForUserLocaleOrPrimary

@Deprecated
public final java.lang.String retrieveValueForUserLocaleOrPrimary(java.util.Locale userLocale,
                                                                              SiteLocaleSettings sls)

Deprecated. This method will be removed in a future release. Use retrieveValueForUserLocaleOrPrimary(Locale, Locale) instead.

Returns the localized value for the user's locale, if available. If the value is not available in the user's locale, it falls back to the site's primary locale.

retrieveValueForUserLocaleOrPrimary

public final java.lang.String retrieveValueForUserLocaleOrPrimary(java.util.Locale userLocale,
                                                                  java.util.Locale primaryLocale)

Returns the localized value for the user's locale, if available. If the value is not available in the user's locale, it falls back to the site's primary locale.

retrieveValueForLocaleOrFirstAvailable

public final java.lang.String retrieveValueForLocaleOrFirstAvailable(java.util.Locale targetLocale)

Returns the localized value for the given locale, if available. If the value is not available in the given locale, returns the first available value. If there are no values at all, returns null.

put

public final void put(java.lang.String text)

put

public final void put(java.util.Locale locale,
                      java.lang.String text)

put

public final void put(java.lang.String locale,
                      java.lang.String text)

toEncodedString

public final java.lang.String toEncodedString()

Returns:

the encoded representation of the mappings contained in this object.

getLocales

public java.util.Set<java.util.Locale> getLocales()

Get the Locale keys for this LocaleString.

Returns:

Set of Locales stored in this LocaleString, which may be empty for LocaleStrings insensitive to Locale

Throws:

java.lang.IllegalStateException - if an invalid Locale is encountered

toString

public java.lang.String toString()

Returns a string representation of the given LocaleString object. The returned string representation is suitable for logging or debugging. This should NOT be used for outputting the string to the end-user.

Overrides:

toString in class java.lang.Object

isExpression

public boolean isExpression()

Returns:

if this LocaleString contains an expression as part of its locale mappings.

getLocalizeExpressionString

public java.lang.String getLocalizeExpressionString()

Returns:

the String representation of the localize expression-function used to validate LocaleString objects that contain expressions in its mappings.

getStringLocales

public java.util.Set<java.lang.String> getStringLocales()

containsLocale

public boolean containsLocale(java.util.Locale locale_)

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

clone

public LocaleString clone()

Clone this LocaleString; the result will have its own locale sensitive map.

Overrides:

clone in class java.lang.Object