com.convallyria.languagy.api.language

Class Translator

java.lang.Object

com.convallyria.languagy.api.language.Translator

public class Translator
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
void	close() Properly cleans up and closes the file watch service.
Translator	debug(boolean debug)
@NotNull java.io.File	getFallback()
@Nullable org.bukkit.configuration.file.FileConfiguration	getFileConfiguration(@NotNull org.bukkit.entity.Player target) Gets the language config for the specified player.
@NotNull HookedPlugin	getHook()
Language	getLanguage(org.bukkit.entity.Player player)
Translation	getTranslationFor(@NotNull org.bukkit.entity.Player target, @NotNull TranslationKey key) Gets the translation for a player.
boolean	isDebug()
static Translator	of(@NotNull org.bukkit.plugin.Plugin plugin) Create a new translator.
static Translator	of(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull Language defaultLanguage) Create a new translator.
static Translator	of(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull java.lang.String folderName, @NotNull Language defaultLanguage) Create a new translator.
Translator	setFallback(java.io.File fallback) Sets the fallback file

Methods inherited from class java.lang.Object

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

Method Detail

close

public void close()

Properly cleans up and closes the file watch service. This is very important, and you should place it in your onDisable method.

of

public static Translator of(@NotNull
                            @NotNull org.bukkit.plugin.Plugin plugin)

Create a new translator. It is important that you call close() in your plugin's onDisable.

Parameters:

plugin - your plugin instance

See Also:

of(Plugin, Language), of(Plugin, String, Language)

of

public static Translator of(@NotNull
                            @NotNull org.bukkit.plugin.Plugin plugin,
                            @NotNull
                            @NotNull Language defaultLanguage)

Create a new translator. It is important that you call close() in your plugin's onDisable.

Parameters:

plugin - your plugin instance

defaultLanguage - the default language you wish to use

See Also:

of(Plugin), of(Plugin, String, Language)

of

public static Translator of(@NotNull
                            @NotNull org.bukkit.plugin.Plugin plugin,
                            @NotNull
                            @NotNull java.lang.String folderName,
                            @NotNull
                            @NotNull Language defaultLanguage)

Create a new translator. It is important that you call close() in your plugin's onDisable.

Parameters:

plugin - your plugin instance

folderName - the folder you wish to use for language files, this should match your resources folder

defaultLanguage - the default language you wish to use

See Also:

of(Plugin), of(Plugin, Language)

setFallback

public Translator setFallback(java.io.File fallback)

Sets the fallback file

Parameters:

fallback - fallback file

Returns:

Translator instance

getHook

@NotNull
public @NotNull HookedPlugin getHook()

getTranslationFor

public Translation getTranslationFor(@NotNull
                                     @NotNull org.bukkit.entity.Player target,
                                     @NotNull
                                     @NotNull TranslationKey key)

Gets the translation for a player.

If the player's locale has no existing translation, then this will use the default language provided in the constructor.

This will also attempt to resolve the type within the config. If it is a list, then that shall be used, otherwise it will be a normal string.

Parameters:

target - the target player

key - the translation key

Returns:

a provided translation

getLanguage

public Language getLanguage(org.bukkit.entity.Player player)

getFileConfiguration

@Nullable
public @Nullable org.bukkit.configuration.file.FileConfiguration getFileConfiguration(@NotNull
                                                                                                 @NotNull org.bukkit.entity.Player target)

Gets the language config for the specified player. This will use the default language provided if the player's locale has no translation file available.

Parameters:

target - the target player

Returns:

configuration file for the player's language

getFallback

@NotNull
public @NotNull java.io.File getFallback()

isDebug

public boolean isDebug()

debug

public Translator debug(boolean debug)