Package com.transifex.txnative.cache

Class TxMemoryCache

java.lang.Object

com.transifex.txnative.cache.TxMemoryCache

All Implemented Interfaces:

TxCache

public class TxMemoryCache
extends Object
implements TxCache

A cache that holds translations in memory.

Constructor Summary

Constructors

Constructor	Description
TxMemoryCache()

Method Summary

Modifier and Type	Method	Description
LocaleData.TranslationMap	get()	Gets all translations from the cache in the form of a TranslationMap object.
String	get(String key, String locale)	Get the translation for a certain key and locale pair.
void	update(LocaleData.TranslationMap translationMap)	Update the cache with the provided TranslationMap.

Methods inherited from class java.lang.Object

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

Constructor Detail

TxMemoryCache

public TxMemoryCache()

Method Detail

get

@NonNull
public LocaleData.TranslationMap get()

Description copied from interface: TxCache

Gets all translations from the cache in the form of a TranslationMap object.

The returned object should not be altered as the cache may use it internally.

Specified by:

get in interface TxCache

get

@Nullable
public String get(@NonNull
                  String key,
                  @NonNull
                  String locale)

Description copied from interface: TxCache

Get the translation for a certain key and locale pair.

Specified by:

get in interface TxCache

Parameters:

key - The key of the string.

locale - The locale code.

Returns:

The string if the key was found in the cache; null if the provided locale does not exist in the cache or the key does not exist for this locale; empty string if the string has not yet been translated for this locale

update

public void update(@NonNull
                   LocaleData.TranslationMap translationMap)

Description copied from interface: TxCache

Update the cache with the provided TranslationMap.

The translation map should not be changed after providing it to the cache, because the cache implementation may use it without making a copy.

Specified by:

update in interface TxCache