Package org.incendo.cloud.translations

Interface TranslationBundle<C>

Type Parameters:

C - command sender type

All Superinterfaces:

CaptionProvider<C>

@API(status=STABLE)
public interface TranslationBundle<C>
extends CaptionProvider<C>

A bundle of translations.

This can be registered to the command manager by accessing the caption registry using CommandManager.captionRegistry() and then registering the provider using CaptionRegistry.registerProvider(CaptionProvider):

TranslationBundle<C> bundle = TranslationBundle.core(sender -> sender.locale());
 manager.captionRegistry().registerProvider(translationBundle);

Method Summary

Modifier and Type	Method	Description
static <C> @NonNull TranslationBundle<C>	core(@NonNull LocaleExtractor<C> localeExtractor)	Returns the translation bundle for the cloud-core translations.
@NonNull LocaleExtractor<C>	localeExtractor()	Returns the extractor that extract locales from senders of type TranslationBundle.
default @Nullable String	provide(@NonNull Caption caption, @NonNull C recipient)
static <C> @NonNull TranslationBundle<C>	resourceBundle(@NonNull String baseName, @NonNull LocaleExtractor<C> localeExtractor)	Creates a new translation bundle backed by aResourceBundle with the given baseName.
@Nullable TranslatedCaptionProvider<C>	translations(@NonNull Locale locale)	Returns the translations for the given locale.

Method Details

resourceBundle

static <C> @NonNull TranslationBundle<C> resourceBundle(@NonNull String baseName,
 @NonNull LocaleExtractor<C> localeExtractor)

Creates a new translation bundle backed by aResourceBundle with the given baseName.

Type Parameters:

C - command sender type

Parameters:

baseName - resource bundle base name

localeExtractor - locale extractor

Returns:

the translation bundle

core

static <C> @NonNull TranslationBundle<C> core(@NonNull LocaleExtractor<C> localeExtractor)

Returns the translation bundle for the cloud-core translations.

Type Parameters:

C - command sender type

Parameters:

localeExtractor - locale extractor

Returns:

the translation bundle

localeExtractor

@NonNull LocaleExtractor<C> localeExtractor()

Returns the extractor that extract locales from senders of type TranslationBundle.

Returns:

locale extractor

translations

@Nullable TranslatedCaptionProvider<C> translations(@NonNull Locale locale)

Returns the translations for the given locale.

Parameters:

locale - translation locale

Returns:

the translations, or null if the given locale is not supported

provide

default @Nullable String provide(@NonNull Caption caption,
 @NonNull C recipient)

Specified by:

provide in interface CaptionProvider<C>