All Superinterfaces:: TranslationStore<MessageFormat>, TranslationStore.StringBased<MessageFormat>, Translator

@Deprecated public interface TranslationRegistry extends Translator, TranslationStore.StringBased<MessageFormat>

Deprecated.

For removal since 4.20.0. Use TranslationStore.messageFormat(Key) instead.

A registry of translations. Used to register localized strings for translation keys. The registry can be submitted to the GlobalTranslator or can translate manually through translate(String, Locale).

The recommended way to register translations is through registerAll(Locale, ResourceBundle, boolean)

Since:: 4.0.0

Nested Class Summary

Nested classes/interfaces inherited from interface net.kyori.adventure.translation.TranslationStore
TranslationStore.StringBased<T>
Field Summary

Fields

Modifier and Type

Field

Description

static final Pattern

SINGLE_QUOTE_PATTERN

Deprecated.
For removal, since 4.20.0, with no replacement.
Method Summary

Modifier and Type

Method

Description

boolean

contains(@NotNull String key)

Deprecated.
For removal since 4.20.0.

static @NotNull TranslationRegistry

create(Key name)

Deprecated.
For removal since 4.20.0.

void

defaultLocale(@NotNull Locale locale)

Deprecated.
For removal since 4.20.0.

void

register(@NotNull String key, @NotNull Locale locale, @NotNull MessageFormat format)

Deprecated.
For removal since 4.20.0.

default void

registerAll(@NotNull Locale locale, @NotNull Path path, boolean escapeSingleQuotes)

Deprecated.
For removal since 4.20.0.

default void

registerAll(@NotNull Locale locale, @NotNull Map<String,MessageFormat> formats)

Deprecated.
For removal since 4.20.0.

default void

registerAll(@NotNull Locale locale, @NotNull ResourceBundle bundle, boolean escapeSingleQuotes)

Deprecated.
For removal since 4.20.0.

default void

registerAll(@NotNull Locale locale, @NotNull Set<String> keys, Function<String,MessageFormat> function)

Deprecated.
For removal since 4.20.0.

@Nullable MessageFormat

translate(@NotNull String key, @NotNull Locale locale)

Deprecated.
For removal since 4.20.0.

void

unregister(@NotNull String key)

Deprecated.
For removal since 4.20.0.

Methods inherited from interface net.kyori.adventure.translation.TranslationStore
canTranslate, contains

Methods inherited from interface net.kyori.adventure.translation.Translator
hasAnyTranslations, name, translate

Field Details
- SINGLE_QUOTE_PATTERN
  
  @Deprecated static final Pattern SINGLE_QUOTE_PATTERN
  
  Deprecated.
  For removal, since 4.20.0, with no replacement.
  
  A pattern which matches a single quote.
  
  Since:
  
  4.0.0
Method Details
- create
  
  @Deprecated @NotNull static @NotNull TranslationRegistry create(Key name)
  
  Deprecated.
  For removal since 4.20.0. Use TranslationStore.messageFormat(Key) instead.
  
  Creates a new standalone translation registry.
  
  Parameters:
  
  name - the registry id
  
  Returns:
  
  a translation registry
  
  Since:
  
  4.0.0
- contains
  
  @Deprecated boolean contains(@NotNull @NotNull String key)
  
  Deprecated.
  For removal since 4.20.0. Use TranslationStore.messageFormat(Key) instead.
  
  Checks if any translations are explicitly registered for the specified key.
  
  Specified by:
  
  contains in interface TranslationStore<MessageFormat>
  
  Parameters:
  
  key - a translation key
  
  Returns:
  
  whether the registry contains a value for the translation key
  
  Since:
  
  4.7.0
- translate
  
  @Deprecated @Nullable @Nullable MessageFormat translate(@NotNull @NotNull String key, @NotNull @NotNull Locale locale)
  
  Deprecated.
  For removal since 4.20.0. Use TranslationStore.messageFormat(Key) instead.
  
  Gets a message format from a key and locale.
  If a translation for locale is not found, we will then try locale without a country code, and then finally fallback to a default locale.
  
  Specified by:
  
  translate in interface Translator
  
  Parameters:
  
  locale - a locale
  
  key - a translation key
  
  Returns:
  
  a message format or null to skip translation
  
  Since:
  
  4.0.0
- defaultLocale
  
  @Deprecated void defaultLocale(@NotNull @NotNull Locale locale)
  
  Deprecated.
  For removal since 4.20.0. Use TranslationStore.messageFormat(Key) instead.
  
  Sets the default locale used by this registry.
  
  Specified by:
  
  defaultLocale in interface TranslationStore<MessageFormat>
  
  Parameters:
  
  locale - the locale to use a default
  
  Since:
  
  4.0.0
- register
  
  @Deprecated void register(@NotNull @NotNull String key, @NotNull @NotNull Locale locale, @NotNull @NotNull MessageFormat format)
  
  Deprecated.
  For removal since 4.20.0. Use TranslationStore.messageFormat(Key) instead.
  Registers a translation.
  final TranslationRegistry registry; registry.register("example.hello", Locale.US, new MessageFormat("Hi, {0}. How are you?"));
  Specified by:
  
  register in interface TranslationStore<MessageFormat>
  
  Parameters:
  
  key - a translation key
  
  locale - a locale
  
  format - a translation format
  
  Throws:
  
  IllegalArgumentException - if the translation key is already exists
  
  Since:
  
  4.0.0
- registerAll
  
  @Deprecated default void registerAll(@NotNull @NotNull Locale locale, @NotNull @NotNull Map<String,MessageFormat> formats)
  
  Deprecated.
  For removal since 4.20.0. Use TranslationStore.messageFormat(Key) instead.
  Registers a map of translations.
  final TranslationRegistry registry; final Map<String, MessageFormat> translations; translations.put("example.greeting", new MessageFormat("Greetings {0}. Doing ok?)); translations.put("example.goodbye", new MessageFormat("Goodbye {0}. Have a nice day!)); registry.registerAll(Locale.US, translations);
  Specified by:
  
  registerAll in interface TranslationStore<MessageFormat>
  
  Parameters:
  
  locale - a locale
  
  formats - a map of translation keys to formats
  
  Throws:
  
  IllegalArgumentException - if a translation key already exists
  
  Since:
  
  4.0.0
  
  See Also:
  
  register(String, Locale, MessageFormat)
- registerAll
  
  @Deprecated default void registerAll(@NotNull @NotNull Locale locale, @NotNull @NotNull Path path, boolean escapeSingleQuotes)
  
  Deprecated.
  For removal since 4.20.0. Use TranslationStore.messageFormat(Key) instead.
  
  Registers a resource bundle of translations.
  Specified by:
  
  registerAll in interface TranslationStore.StringBased<MessageFormat>
  
  Parameters:
  
  locale - a locale
  
  path - a path to the resource bundle
  
  escapeSingleQuotes - whether to escape single quotes
  
  Throws:
  
  IllegalArgumentException - if a translation key already exists
  
  Since:
  
  4.0.0
  
  See Also:
  
  registerAll(Locale, ResourceBundle, boolean)
- registerAll
  
  @Deprecated default void registerAll(@NotNull @NotNull Locale locale, @NotNull @NotNull ResourceBundle bundle, boolean escapeSingleQuotes)
  
  Deprecated.
  For removal since 4.20.0. Use TranslationStore.messageFormat(Key) instead.
  Registers a resource bundle of translations.
  It is highly recommended to create your bundle using UTF8ResourceBundleControl as your bundle control for UTF-8 support - for example:
  
  final ResourceBundle bundle = ResourceBundle.getBundle("my_bundle", Locale.GERMANY, UTF8ResourceBundleControl.get()); registry.registerAll(Locale.GERMANY, bundle, false);
  Specified by:
  
  registerAll in interface TranslationStore.StringBased<MessageFormat>
  
  Parameters:
  
  locale - a locale
  
  bundle - a resource bundle
  
  escapeSingleQuotes - whether to escape single quotes
  
  Throws:
  
  IllegalArgumentException - if a translation key already exists
  
  Since:
  
  4.0.0
  
  See Also:
  
  UTF8ResourceBundleControl
- registerAll
  
  @Deprecated default void registerAll(@NotNull @NotNull Locale locale, @NotNull @NotNull Set<String> keys, Function<String,MessageFormat> function)
  
  Deprecated.
  For removal since 4.20.0. Use TranslationStore.messageFormat(Key) instead.
  
  Registers a resource bundle of translations.
  
  Specified by:
  
  registerAll in interface TranslationStore<MessageFormat>
  
  Parameters:
  
  locale - a locale
  
  keys - the translation keys to register
  
  function - a function to transform a key into a message format
  
  Throws:
  
  IllegalArgumentException - if a translation key already exists
  
  Since:
  
  4.0.0
- unregister
  
  @Deprecated void unregister(@NotNull @NotNull String key)
  
  Deprecated.
  For removal since 4.20.0. Use TranslationStore.messageFormat(Key) instead.
  
  Unregisters a translation key.
  
  Specified by:
  
  unregister in interface TranslationStore<MessageFormat>
  
  Parameters:
  
  key - a translation key
  
  Since:
  
  4.0.0

Interface TranslationRegistry

Nested Class Summary

Nested classes/interfaces inherited from interface net.kyori.adventure.translation.TranslationStore

Field Summary

Method Summary

Methods inherited from interface net.kyori.adventure.translation.TranslationStore

Methods inherited from interface net.kyori.adventure.translation.Translator

Field Details

SINGLE_QUOTE_PATTERN

Method Details

create

contains

translate

defaultLocale

register

registerAll

registerAll

registerAll

registerAll

unregister