Class TranslationPackageDiff
- java.lang.Object
-
- com.inductiveautomation.ignition.common.i18n.translation.BasicTranslationPackage
-
- com.inductiveautomation.ignition.common.i18n.translation.TranslationPackageDiff
-
- All Implemented Interfaces:
MutableTranslationPackage
,TranslationPackage
,java.io.Serializable
,java.lang.Iterable<Translation>
public class TranslationPackageDiff extends BasicTranslationPackage implements MutableTranslationPackage, java.lang.Iterable<Translation>
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.inductiveautomation.ignition.common.i18n.translation.BasicTranslationPackage
BasicTranslationPackage.TranslationIterator
-
-
Field Summary
Fields Modifier and Type Field Description protected java.util.Set<java.lang.String>
removedKeys
protected java.util.Set<java.util.Locale>
removedLocales
protected java.util.Set<java.util.Map.Entry<java.util.Locale,java.lang.String>>
removedTranslations
-
Constructor Summary
Constructors Constructor Description TranslationPackageDiff()
TranslationPackageDiff(java.util.Locale baseLocale, KeyHashRule hashRule)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addTerm(java.lang.String key)
Ensures that the specified key is in the translation package.void
addTranslation(java.lang.String key, java.util.Locale locale, java.lang.String value)
Sets a translation for the specified key and locale.void
addTranslations(java.lang.String key, TranslationMap translations)
Sets all of the translations for a specific key.void
clearChanges(java.util.Locale locale)
Removes any modified terms for the given locale.void
ensureLocaleExists(java.util.Locale locale)
Verifies that the locale is present, adding it if necessary.java.util.Set<java.lang.String>
getRemovedKeys()
Returns an unmodifiable set of the removed keys *java.util.Set<java.util.Locale>
getRemovedLocales()
java.util.Set<java.util.Map.Entry<java.util.Locale,java.lang.String>>
getRemovedTranslations()
boolean
hasChanges()
boolean
isModified(java.lang.String key)
boolean
isModified(java.lang.String key, java.util.Locale locale)
boolean
isRemoved(java.lang.String key)
boolean
isRemoved(java.util.Locale locale)
java.util.Iterator<Translation>
iterator()
protected TermKey
registerIndexKey(java.lang.String key)
boolean
removeKey(java.lang.String key)
Removes the specific key, and any translations.void
removeLocale(java.util.Locale locale)
void
removeTranslation(java.lang.String term, java.util.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 com.inductiveautomation.ignition.common.i18n.translation.TranslationPackage
createDiff, get, getAllTranslations, getAvailableKeys, getAvailableLocales, getBaseLocale, getKeyHashRule, getStrict, getTranslationsFor, isDefined, isDefined
-
-
-
-
Constructor Detail
-
TranslationPackageDiff
public TranslationPackageDiff()
-
TranslationPackageDiff
public TranslationPackageDiff(java.util.Locale baseLocale, KeyHashRule hashRule)
-
-
Method Detail
-
getRemovedKeys
public java.util.Set<java.lang.String> getRemovedKeys()
Returns an unmodifiable set of the removed keys *
-
getRemovedLocales
public java.util.Set<java.util.Locale> getRemovedLocales()
-
addTerm
public void addTerm(java.lang.String key)
Description copied from interface:MutableTranslationPackage
Ensures that the specified key is in the translation package.- Specified by:
addTerm
in interfaceMutableTranslationPackage
- Overrides:
addTerm
in classBasicTranslationPackage
-
isModified
public boolean isModified(java.lang.String key)
-
isModified
public boolean isModified(java.lang.String key, java.util.Locale locale)
-
isRemoved
public boolean isRemoved(java.lang.String key)
-
isRemoved
public boolean isRemoved(java.util.Locale locale)
-
clearChanges
public void clearChanges(java.util.Locale locale)
Removes any modified terms for the given locale. Does not mark the locale as deleted. *
-
registerIndexKey
protected TermKey registerIndexKey(java.lang.String key)
-
addTranslation
public void addTranslation(java.lang.String key, java.util.Locale locale, java.lang.String value)
Description copied from interface:MutableTranslationPackage
Sets a translation for the specified key and locale.- Specified by:
addTranslation
in interfaceMutableTranslationPackage
- Overrides:
addTranslation
in classBasicTranslationPackage
-
addTranslations
public void addTranslations(java.lang.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 interfaceMutableTranslationPackage
- Overrides:
addTranslations
in classBasicTranslationPackage
-
removeTranslation
public void removeTranslation(java.lang.String term, java.util.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.- Specified by:
removeTranslation
in interfaceMutableTranslationPackage
- Overrides:
removeTranslation
in classBasicTranslationPackage
-
removeKey
public boolean removeKey(java.lang.String key)
Description copied from interface:MutableTranslationPackage
Removes the specific key, and any translations.- Specified by:
removeKey
in interfaceMutableTranslationPackage
- Overrides:
removeKey
in classBasicTranslationPackage
- Returns:
- true if key was present
-
ensureLocaleExists
public void ensureLocaleExists(java.util.Locale locale)
Description copied from interface:MutableTranslationPackage
Verifies that the locale is present, adding it if necessary.- Specified by:
ensureLocaleExists
in interfaceMutableTranslationPackage
- Overrides:
ensureLocaleExists
in classBasicTranslationPackage
-
removeLocale
public void removeLocale(java.util.Locale locale)
- Specified by:
removeLocale
in interfaceMutableTranslationPackage
- Overrides:
removeLocale
in classBasicTranslationPackage
-
hasChanges
public boolean hasChanges()
-
iterator
public java.util.Iterator<Translation> iterator()
- Specified by:
iterator
in interfacejava.lang.Iterable<Translation>
-
getRemovedTranslations
public java.util.Set<java.util.Map.Entry<java.util.Locale,java.lang.String>> getRemovedTranslations()
-
-