de.aristaflow.adept2.model.common.i18n

Class TranslationDataAdapter

java.lang.Object

de.aristaflow.adept2.model.common.i18n.TranslationDataAdapter

public class TranslationDataAdapter
extends java.lang.Object

Facilitates the getting of setting of translatable attributes and their translations.

Author:

Patrick Schmidt

Constructor Summary

Constructors

Constructor and Description
TranslationDataAdapter(PluginData pluginData, java.lang.Class<?> viewInterface)
TranslationDataAdapter(java.lang.String pluginID, java.lang.Class<?> viewInterface, java.util.Map<java.lang.String,java.lang.String> pluginData)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPluginID()
java.util.Set<java.lang.String>	getTranslatableAttributes()
java.util.Locale[]	getUsedLocales()
java.lang.String	getValue(java.lang.String attrName, java.util.Locale locale) Returns the value of the specified attribute in the given locale.
void	removeTranslations(java.util.Locale locale) Removes all translations for the given locale.
void	removeValue(java.lang.String attrName, java.util.Locale locale)
void	setValue(java.lang.String attrName, java.lang.String value, java.util.Locale locale) Sets the value of the specified attribute in the given locale to the given value.

Methods inherited from class java.lang.Object

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

Constructor Detail

TranslationDataAdapter

public TranslationDataAdapter(PluginData pluginData,
                              java.lang.Class<?> viewInterface)

TranslationDataAdapter

public TranslationDataAdapter(java.lang.String pluginID,
                              java.lang.Class<?> viewInterface,
                              java.util.Map<java.lang.String,java.lang.String> pluginData)

Method Detail

getTranslatableAttributes

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

getPluginID

public java.lang.String getPluginID()

getValue

public java.lang.String getValue(java.lang.String attrName,
                                 java.util.Locale locale)

Returns the value of the specified attribute in the given locale.

Parameters:

attrName - name of the desired attribute

locale - the locale for which to get the translated value; use null to get the default value

Returns:

the value of the specified attribute in the given locale; could be null

setValue

public void setValue(java.lang.String attrName,
                     java.lang.String value,
                     java.util.Locale locale)

Sets the value of the specified attribute in the given locale to the given value.

Parameters:

attrName - name of the desired attribute

value - the new value of the specified attribute in the given locale

locale - the locale for which to set the translated value; use null to set the default value

removeValue

public void removeValue(java.lang.String attrName,
                        java.util.Locale locale)

Parameters:

attrName - name of the desired attribute

locale - the locale for which to remove the translated value; use null to remove the default value

removeTranslations

public void removeTranslations(java.util.Locale locale)

Removes all translations for the given locale.

Parameters:

locale - the locale for which to remove all translations

getUsedLocales

public java.util.Locale[] getUsedLocales()