Module net.kyori.adventure.api

Package net.kyori.adventure.translation

Class AbstractTranslationStore.StringBased<T>

java.lang.Object

net.kyori.adventure.translation.AbstractTranslationStore<T>

net.kyori.adventure.translation.AbstractTranslationStore.StringBased<T>

Type Parameters:

T - the type of the translation

All Implemented Interfaces:

TranslationStore<T>, TranslationStore.StringBased<T>, Translator

Enclosing class:

AbstractTranslationStore<T>

public abstract static class AbstractTranslationStore.StringBased<T>
extends AbstractTranslationStore<T>
implements TranslationStore.StringBased<T>

An abstract, string-based translation store.

This class extends upon the standard abstract translation store by adding support for reading from resource bundles.

Since:

4.20.0

Nested Class Summary

Nested classes/interfaces inherited from class net.kyori.adventure.translation.AbstractTranslationStore

AbstractTranslationStore.StringBased<T>

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

TranslationStore.StringBased<T>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StringBased(Key name)	Creates a new abstract, string-based translation store with a given name.

Method Summary

Modifier and Type	Method	Description
protected abstract T	parse(String string, Locale locale)	Parses a string into the format required for this translation store.
final void	registerAll(Locale locale, Path path, boolean escapeSingleQuotes)	Registers a resource bundle of translations.
final void	registerAll(Locale locale, ResourceBundle bundle, boolean escapeSingleQuotes)	Registers a resource bundle of translations.

Methods inherited from class net.kyori.adventure.translation.AbstractTranslationStore

canTranslate, contains, contains, defaultLocale, equals, hasAnyTranslations, hashCode, name, register, registerAll, registerAll, toString, translationValue, unregister

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

canTranslate, contains, contains, defaultLocale, register, registerAll, registerAll, unregister

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

hasAnyTranslations, name, translate, translate

Constructor Details

StringBased

protected StringBased(Key name)

Creates a new abstract, string-based translation store with a given name.

Parameters:

name - the name

Since:

4.20.0

Method Details

parse

protected abstract T parse(String string,
 Locale locale)

Parses a string into the format required for this translation store.

Parameters:

string - the string

locale - the locale for the string, if needed

Returns:

the parsed type

Since:

4.20.0

registerAll

public final void registerAll(Locale locale,
 Path path,
 boolean escapeSingleQuotes)

Description copied from interface: TranslationStore.StringBased

Registers a resource bundle of translations.

Specified by:

registerAll in interface TranslationStore.StringBased<T>

Parameters:

locale - a locale

path - a path to the resource bundle

escapeSingleQuotes - whether to escape single quotes

See Also:

• TranslationStore.StringBased.registerAll(Locale, ResourceBundle, boolean)

registerAll

public final void registerAll(Locale locale,
 ResourceBundle bundle,
 boolean escapeSingleQuotes)

Description copied from interface: TranslationStore.StringBased

Registers a resource bundle of translations.

Specified by:

registerAll in interface TranslationStore.StringBased<T>

Parameters:

locale - a locale

bundle - a resource bundle

escapeSingleQuotes - whether to escape single quotes