Package ca.stellardrift.permissionsex.util

Class TranslatableProvider

java.lang.Object

ca.stellardrift.permissionsex.util.TranslatableProvider

All Implemented Interfaces:

net.kyori.adventure.text.ComponentLike

public final class TranslatableProvider
extends Object
implements net.kyori.adventure.text.ComponentLike

A typesafe provider for translatable messages.

Designed for use from generated code containing translation keys.

Since:

2.0.0

Constructor Summary

Constructors

Constructor	Description
TranslatableProvider(String bundle, String key)	Create a new translatable provider

Method Summary

Modifier and Type	Method	Description
@NonNull net.kyori.adventure.text.Component	asComponent()
net.kyori.adventure.text.TranslatableComponent.Builder	bTr(Object... args)	Create a translatable component builder configured with the provided arguments.
String	key()	The translation key used for lookup.
static Stream<Locale>	knownLocales(Class<?> loaderOf, String bundleName)	Get known locales for a certain bundle name.
static void	registerAllTranslations(String bundleName, Stream<Locale> languages, ClassLoader loader)
net.kyori.adventure.text.TranslatableComponent	tr(Object... args)	Create a translatable component with the provided arguments.

Methods inherited from class java.lang.Object

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

Constructor Detail

TranslatableProvider

public TranslatableProvider(String bundle,
                            String key)

Create a new translatable provider

Parameters:

bundle - the name of the ResourceBundle containing the message

key - the translation key

Method Detail

key

public String key()

The translation key used for lookup.

Returns:

the translation key

Since:

2.0.0

tr

public net.kyori.adventure.text.TranslatableComponent tr(Object... args)

Create a translatable component with the provided arguments.

Parameters:

args - the arguments

Returns:

a new translatable component

Since:

2.0.0

bTr

public net.kyori.adventure.text.TranslatableComponent.Builder bTr(Object... args)

Create a translatable component builder configured with the provided arguments.

Parameters:

args - the arguments

Returns:

a new builder

Since:

2.0.0

asComponent

public @NonNull net.kyori.adventure.text.Component asComponent()

This will create a component without any arguments.

Specified by:

asComponent in interface net.kyori.adventure.text.ComponentLike

knownLocales

public static Stream<Locale> knownLocales(Class<?> loaderOf,
                                          String bundleName)

Get known locales for a certain bundle name.

Parameters:

loaderOf - The class to use to determine a code source

bundleName - the name of the bundle to find languages of

Returns:

the known locales

registerAllTranslations

public static void registerAllTranslations(String bundleName,
                                           Stream<Locale> languages,
                                           ClassLoader loader)