BBTranslationBundle

```
public static class BBTranslationBundle
```
BBTranslationBundle The BBTranslationBundle class is a BBj CustomObject used to get and add translations with backend Java properties files for localization support.

See Also:
[]

Field Summary

Fields
Modifier and Type	Field and Description
`static BBjNumber`	`DIR_ERROR=258`
`static BBjNumber`	`NAME_ERROR=256`
`static BBjNumber`	`NumConsolePrints`
`static BBjNumber`	`REMOVE_LOCALE_ERROR=257`
`static BBjNumber`	`SAVE_ERROR=259`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addLocale(Locale p_locale!)`
`void`	`addTranslation(BBjString p_key$, HashMap p_values!)`
`void`	`addTranslation(BBjString p_key$, HashMap p_values!, BBjNumber p_skip_existing)`
`void`	`addTranslation(Locale p_locale!, BBjString p_key$, BBjString p_value$)`
`void`	`addTranslation(Locale p_locale!, BBjString p_key$, BBjString p_value$, BBjNumber p_skip_existing)`
`void`	`clearCache()`
`static void`	`createParentDirs(BBjString p_fileName!)`
`static BBTranslationBundle`	`getBundle(BBjString p_name!)`
`static BBTranslationBundle`	`getBundle(BBjString p_name!, BBjString p_directory!)`
`static BBTranslationBundle`	`getBundle(BBjString p_name!, BBjString p_directory!, Locale p_localeOfOrigin!)`
`static BBTranslationBundle`	`getBundleFromJar(BBjString p_name!, BBjString p_jarFileName!, Locale p_localeOfOrigin!)`
`static BBTranslationBundle`	`getBundleFromZip(BBjString p_name!, BBjString p_zipFileName!, Locale p_localeOfOrigin!)`
`static BBjString`	`getBundleLockUser(BBjString p_name!, BBjString p_directory!)`
`static Locale`	`getClientLocale()`
`static BBjString`	`getClientLocaleString()`
`BBTranslations`	`getDefaultTranslations()`
`BBjString`	`getDirectory()`
`Locale`	`getLocaleOfOrigin()`
`BBjVector`	`getLocales()`
`BBjString`	`getName()`
`BBjString`	`getTranslation(Locale p_locale!, BBjString p_key$)`
`BBjString`	`getTranslation(Locale p_locale!, BBjString p_key$, BBjString p_defaultValue!)`
`BBjString`	`getTranslation(Locale p_locale!, BBjString p_key$, BBjString p_defaultValue!, BBjNumber p_addIfNotFound)`
`BBjString`	`getTranslation(Locale p_locale!, BBjString p_key$, BBjString p_defaultValue!, BBjNumber p_addIfNotFound, BBjNumber p_forceAdd)`
`BBjString`	`getTranslation(Locale p_locale!, BBjString p_key$, BBjString p_defaultValue!, BBjNumber p_addIfNotFound, BBjNumber p_forceAdd, BBjNumber p_skipParentLocale)`
`BBTranslations`	`getTranslations(Locale p_locale!)`
`static BBjNumber`	`obtainBundleLock(BBjString p_name!, BBjString p_directory!)`
`static void`	`print(BBjNumber p_printChan, BBjString p_text$)`
`static void`	`print(BBjNumber p_printChan, BBjString p_text!, BBjNumber p_wrapText, BBjNumber p_pauseConsole)`
`static BBjNumber`	`releaseBundleLock(BBjString p_name!, BBjString p_directory!)`
`void`	`removeLocale(Locale p_locale!)`
`void`	`removeTranslation(Locale p_locale!, BBjString p_key$)`
`void`	`save()`
`void`	`save(BBjString p_directory!)`
`void`	`save(BBjString p_directory!, BBjString p_bundleName!)`
`void`	`save(BBjString p_directory!, BBjString p_bundleName!, BBjNumber p_forceSave)`
`void`	`saveTranslationsToJar(BBjString p_jarFileName$)`
`void`	`saveTranslationsToZip(BBjString p_zipFileName$)`
`void`	`setTranslation(Locale p_locale!, BBjString p_key$, BBjString p_value$)`
`static void`	`validateBundle(BBjString p_bundleName$, BBjString p_bundleDir!)`
`static void`	`validateBundle(BBjString p_bundleName$, BBjString p_bundleDir!, BBjString p_validationReportFileName!)`
`static void`	`validateBundle(BBjString p_bundleName$, BBjString p_bundleDir!, BBjString p_validationReportFileName!, BBjNumber p_removeInvalidTranslations)`
`static void`	`writePropertiesFile(BBjString p_propertiesFileName$, SortedProperties p_properties!)`

Field Detail

DIR_ERROR=258
```
public static BBjNumber DIR_ERROR=258
```

NAME_ERROR=256
```
public static BBjNumber NAME_ERROR=256
```

NumConsolePrints

public static BBjNumber NumConsolePrints

REMOVE_LOCALE_ERROR=257

public static BBjNumber REMOVE_LOCALE_ERROR=257

SAVE_ERROR=259
```
public static BBjNumber SAVE_ERROR=259
```

Method Detail

addLocale

public void addLocale(Locale p_locale!)

addTranslation

public void addTranslation(BBjString p_key$, HashMap p_values!)

addTranslation

public void addTranslation(BBjString p_key$, HashMap p_values!, BBjNumber p_skip_existing)

addTranslation

public void addTranslation(Locale p_locale!, BBjString p_key$, BBjString p_value$)

addTranslation

public void addTranslation(Locale p_locale!, BBjString p_key$, BBjString p_value$, BBjNumber p_skip_existing)

clearCache
```
public void clearCache()
```

createParentDirs

public static void createParentDirs(BBjString p_fileName!)

getBundle

public static BBTranslationBundle getBundle(BBjString p_name!)

getBundle

public static BBTranslationBundle getBundle(BBjString p_name!, BBjString p_directory!)

getBundle

public static BBTranslationBundle getBundle(BBjString p_name!, BBjString p_directory!, Locale p_localeOfOrigin!)

getBundleFromJar

public static BBTranslationBundle getBundleFromJar(BBjString p_name!, BBjString p_jarFileName!, Locale p_localeOfOrigin!)

getBundleFromZip

public static BBTranslationBundle getBundleFromZip(BBjString p_name!, BBjString p_zipFileName!, Locale p_localeOfOrigin!)

getBundleLockUser

public static BBjString getBundleLockUser(BBjString p_name!, BBjString p_directory!)

getClientLocale
```
public static Locale getClientLocale()
```

getClientLocaleString

public static BBjString getClientLocaleString()

getDefaultTranslations

public BBTranslations getDefaultTranslations()

getDirectory
```
public BBjString getDirectory()
```

getLocaleOfOrigin
```
public Locale getLocaleOfOrigin()
```

getLocales
```
public BBjVector getLocales()
```

getName
```
public BBjString getName()
```

getTranslation

public BBjString getTranslation(Locale p_locale!, BBjString p_key$)

getTranslation

public BBjString getTranslation(Locale p_locale!, BBjString p_key$, BBjString p_defaultValue!)

getTranslation

public BBjString getTranslation(Locale p_locale!, BBjString p_key$, BBjString p_defaultValue!, BBjNumber p_addIfNotFound)

getTranslation

public BBjString getTranslation(Locale p_locale!, BBjString p_key$, BBjString p_defaultValue!, BBjNumber p_addIfNotFound, BBjNumber p_forceAdd)

getTranslation

public BBjString getTranslation(Locale p_locale!, BBjString p_key$, BBjString p_defaultValue!, BBjNumber p_addIfNotFound, BBjNumber p_forceAdd, BBjNumber p_skipParentLocale)

getTranslations

public BBTranslations getTranslations(Locale p_locale!)

obtainBundleLock

public static BBjNumber obtainBundleLock(BBjString p_name!, BBjString p_directory!)

print

public static void print(BBjNumber p_printChan, BBjString p_text$)

print

public static void print(BBjNumber p_printChan, BBjString p_text!, BBjNumber p_wrapText, BBjNumber p_pauseConsole)

releaseBundleLock

public static BBjNumber releaseBundleLock(BBjString p_name!, BBjString p_directory!)

removeLocale

public void removeLocale(Locale p_locale!)

removeTranslation

public void removeTranslation(Locale p_locale!, BBjString p_key$)

save
```
public void save()
```

save

public void save(BBjString p_directory!)

save

public void save(BBjString p_directory!, BBjString p_bundleName!)

save

public void save(BBjString p_directory!, BBjString p_bundleName!, BBjNumber p_forceSave)

saveTranslationsToJar

public void saveTranslationsToJar(BBjString p_jarFileName$)

saveTranslationsToZip

public void saveTranslationsToZip(BBjString p_zipFileName$)

setTranslation

public void setTranslation(Locale p_locale!, BBjString p_key$, BBjString p_value$)

validateBundle

public static void validateBundle(BBjString p_bundleName$, BBjString p_bundleDir!)

validateBundle

public static void validateBundle(BBjString p_bundleName$, BBjString p_bundleDir!, BBjString p_validationReportFileName!)

validateBundle

public static void validateBundle(BBjString p_bundleName$, BBjString p_bundleDir!, BBjString p_validationReportFileName!, BBjNumber p_removeInvalidTranslations)

writePropertiesFile

public static void writePropertiesFile(BBjString p_propertiesFileName$, SortedProperties p_properties!)

Class BBTranslationBundle

Field Summary

Method Summary

Field Detail

DIR_ERROR=258

NAME_ERROR=256

NumConsolePrints

REMOVE_LOCALE_ERROR=257

SAVE_ERROR=259

Method Detail

addLocale

addTranslation

addTranslation

addTranslation

addTranslation

clearCache

createParentDirs

getBundle

getBundle

getBundle

getBundleFromJar

getBundleFromZip

getBundleLockUser

getClientLocale

getClientLocaleString

getDefaultTranslations

getDirectory

getLocaleOfOrigin

getLocales

getName

getTranslation

getTranslation

getTranslation

getTranslation

getTranslation

getTranslations

obtainBundleLock

print

print

releaseBundleLock

removeLocale

removeTranslation

save

save

save

save

saveTranslationsToJar

saveTranslationsToZip

setTranslation

validateBundle

validateBundle

validateBundle

writePropertiesFile