Package com.inductiveautomation.ignition.common.i18n.translation

Class TranslationPackageDiff

java.lang.Object

com.inductiveautomation.ignition.common.i18n.translation.BasicTranslationPackage

com.inductiveautomation.ignition.common.i18n.translation.TranslationPackageDiff

All Implemented Interfaces:

MutableTranslationPackage, TranslationPackage, Iterable<Translation>

public class TranslationPackageDiff
extends BasicTranslationPackage
implements Iterable<Translation>

A specialized translation package that tracks added, modified, and removed keys and translations.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TranslationPackageDiff.JsonAdapter
static final record	TranslationPackageDiff.RemovedTranslation

Field Summary

Fields

Modifier and Type	Field	Description
protected Set<String>	removedKeys
protected Set<Locale>	removedLocales
protected Set<TranslationPackageDiff.RemovedTranslation>	removedTranslations

Fields inherited from class com.inductiveautomation.ignition.common.i18n.translation.BasicTranslationPackage

baseLocale, bundles, hashRule, index

Constructor Summary

Constructors

Constructor	Description
TranslationPackageDiff()
TranslationPackageDiff(Locale baseLocale, KeyHashRule hashRule)

Method Summary

Modifier and Type	Method	Description
void	addTerm(String key)	Ensures that the specified key is in the translation package.
void	addTranslation(String key, Locale locale, String value)	Sets a translation for the specified key and locale.
void	addTranslations(String key, TranslationMap translations)	Sets all of the translations for a specific key.
void	clearChanges(Locale locale)	Removes any modified terms for the given locale.
void	ensureLocaleExists(Locale locale)	Verifies that the locale is present, adding it if necessary.
Set<String>	getRemovedKeys()	Returns an unmodifiable set of the removed keys *
Set<Locale>	getRemovedLocales()
Set<TranslationPackageDiff.RemovedTranslation>	getRemovedTranslations()
boolean	hasChanges()
boolean	isModified(String key)
boolean	isModified(String key, Locale locale)
boolean	isRemoved(String key)
boolean	isRemoved(Locale locale)
@NonNull Iterator<Translation>	iterator()
protected TermKey	registerIndexKey(String key)
boolean	removeKey(String key)	Removes the specific key, and any translations.
void	removeLocale(Locale locale)
void	removeTranslation(String term, Locale locale)	Removes a translation for a specified key and locale.

Methods inherited from class com.inductiveautomation.ignition.common.i18n.translation.BasicTranslationPackage

applyPackage, createDiff, equals, get, getAllTranslations, getAvailableKeys, getAvailableLocales, getBaseLocale, getBundle, getIndex, getKeyHashRule, getOrCreateBundle, getOrCreateTermKey, getOrNull, getStrict, getTermKey, getTranslationsFor, hashKey, isDefined, isDefined, setBaseLocale, setIndex, setKeyHashRule, updateIndex

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

removedKeys

protected Set<String> removedKeys

removedLocales

protected Set<Locale> removedLocales

removedTranslations

protected Set<TranslationPackageDiff.RemovedTranslation> removedTranslations

Constructor Details

TranslationPackageDiff

public TranslationPackageDiff()

TranslationPackageDiff

public TranslationPackageDiff(Locale baseLocale,
 KeyHashRule hashRule)

Method Details

getRemovedKeys

public Set<String> getRemovedKeys()

Returns an unmodifiable set of the removed keys *

getRemovedLocales

public Set<Locale> getRemovedLocales()

addTerm

public void addTerm(String key)

Description copied from interface: MutableTranslationPackage

Ensures that the specified key is in the translation package. This registers a key without necessarily providing a translation immediately.

Specified by:

addTerm in interface MutableTranslationPackage

Overrides:

addTerm in class BasicTranslationPackage

Parameters:

key - The key to add.

isModified

public boolean isModified(String key)

isModified

public boolean isModified(String key,
 Locale locale)

isRemoved

public boolean isRemoved(String key)

isRemoved

public boolean isRemoved(Locale locale)

clearChanges

public void clearChanges(Locale locale)

Removes any modified terms for the given locale. Does not mark the locale as deleted. *

registerIndexKey

protected TermKey registerIndexKey(String key)

addTranslation

public void addTranslation(String key,
 Locale locale,
 String value)

Description copied from interface: MutableTranslationPackage

Sets a translation for the specified key and locale.

Specified by:

addTranslation in interface MutableTranslationPackage

Overrides:

addTranslation in class BasicTranslationPackage

Parameters:

key - The key to translate.

locale - The target locale.

value - The translated string.

addTranslations

public void addTranslations(String key,
 TranslationMap translations)

Description copied from interface: MutableTranslationPackage

Sets all of the translations for a specific key. Translation map can be null, in which case the key will simply be registered in the index.

Specified by:

addTranslations in interface MutableTranslationPackage

Overrides:

addTranslations in class BasicTranslationPackage

removeTranslation

public void removeTranslation(String term,
 Locale locale)

Description copied from interface: MutableTranslationPackage

Removes a translation for a specified key and locale. Used when someone had a translation and blanks it out. This removes the specific translation but keeps the key in the package.

Specified by:

removeTranslation in interface MutableTranslationPackage

Overrides:

removeTranslation in class BasicTranslationPackage

Parameters:

term - The key to modify.

locale - The locale for which to remove the translation.

removeKey

public boolean removeKey(String key)

Description copied from interface: MutableTranslationPackage

Removes the specific key, and any translations.

Specified by:

removeKey in interface MutableTranslationPackage

Overrides:

removeKey in class BasicTranslationPackage

Returns:

true if key was present

ensureLocaleExists

public void ensureLocaleExists(Locale locale)

Description copied from interface: MutableTranslationPackage

Verifies that the locale is present, adding it if necessary.

Specified by:

ensureLocaleExists in interface MutableTranslationPackage

Overrides:

ensureLocaleExists in class BasicTranslationPackage

removeLocale

public void removeLocale(Locale locale)

Specified by:

removeLocale in interface MutableTranslationPackage

Overrides:

removeLocale in class BasicTranslationPackage

hasChanges

public boolean hasChanges()

Returns:

True if there are any removals, additions, or modifications in this diff.

iterator

public @NonNull Iterator<Translation> iterator()

Specified by:

iterator in interface Iterable<Translation>

getRemovedTranslations

public Set<TranslationPackageDiff.RemovedTranslation> getRemovedTranslations()