Package net.guizhanss.guizhanlib.localization

Class Localization

java.lang.Object

net.guizhanss.guizhanlib.localization.Localization

Direct Known Subclasses:

MinecraftLocalization

public class Localization
extends Object

Localization service. Should be initialized after loading config file and before registering items.

Localization service will create a folder "lang" (by default) under plugin's data folder.

When getting strings from language file, the first loaded language goes first.

Author:

ybw0014

Constructor Summary

Constructors

Constructor	Description
Localization(JavaPlugin plugin)	Constructor
Localization(JavaPlugin plugin, String folderName)	Constructor
Localization(JavaPlugin plugin, String folderName, String langFile)	Constructor

Method Summary

Modifier and Type	Method	Description
final void	addLanguage(String langFilename)	Load a language file to configuration
String	getString(String path)	Get localized String from path.
String[]	getStringArray(String path)	Get localized String array from path.
List<String>	getStringList(String path)	Get localized String List from path.

Methods inherited from class java.lang.Object

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

Constructor Details

Localization

@ParametersAreNonnullByDefault
public Localization(JavaPlugin plugin)

Constructor

Parameters:

plugin - The JavaPlugin instance.

Localization

@ParametersAreNonnullByDefault
public Localization(JavaPlugin plugin,
 String folderName)

Constructor

Parameters:

plugin - The JavaPlugin instance

folderName - The name of the folder that holds all language files

Localization

@ParametersAreNonnullByDefault
public Localization(JavaPlugin plugin,
 String folderName,
 String langFile)

Constructor

Parameters:

plugin - The JavaPlugin instance.

folderName - The name of the folder that holds all language files.

langFile - The name of language file (without file extension .yml)

Method Details

addLanguage

public final void addLanguage(@Nonnull
 String langFilename)

Load a language file to configuration

Parameters:

langFilename - the filename of language file without extension .yml

getString

@Nonnull
public String getString(@Nonnull
 String path)

Get localized String from path.

Parameters:

path - The localization path.

Returns:

Localized String, empty if string is not found.

getStringList

@Nonnull
public List<String> getStringList(@Nonnull
 String path)

Get localized String List from path.

Parameters:

path - The localization path.

Returns:

Localized String List.

getStringArray

@Nonnull
public String[] getStringArray(@Nonnull
 String path)

Get localized String array from path.

Parameters:

path - the localization path.

Returns:

Localized String array.