com.chrismin13.additionsapi.files

Class LangFile

java.lang.Object

com.chrismin13.additionsapi.files.LangFile

public class LangFile
extends java.lang.Object

Offers an easy way to access the lang.yml without having to get the plugin's instance every time. Instead, most of the file's values can be received easily without having to know the value names.
You must use getInstance() to access the file and it's values.

Author:

chrismin13

Method Summary

Modifier and Type	Method and Description
LangFile	addEntry(java.lang.String pluginName, java.lang.String entryName, java.lang.String value) Add a lang.yml entry.
java.lang.String	getEntry(java.lang.String pluginName, java.lang.String entryName) Get an entry's value from the lang.yml file.
static LangFile	getInstance()
org.bukkit.configuration.file.YamlConfiguration	getLang()
LangFile	reloadLang() Reloads the Lang File, updating any changes.
LangFile	saveLang() Saves the Lang File.
LangFile	setup() This method is run when the plugin is enabled and when reloading.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static LangFile getInstance()

setup

public LangFile setup()

This method is run when the plugin is enabled and when reloading. Not meant to be used in any other occasion.

addEntry

public LangFile addEntry(java.lang.String pluginName,
                         java.lang.String entryName,
                         java.lang.String value)

Add a lang.yml entry.

Parameters:

pluginName - The name of your plugin. This is similar to the ID Name first part for CustomItems. For example: "additons_api" or "vanilla_additions".

entryName - The name of the entry.

value - The default value of the entry. This will not be overriden if there is a value already in place in the file.

getEntry

public java.lang.String getEntry(java.lang.String pluginName,
                                 java.lang.String entryName)

Get an entry's value from the lang.yml file.

Parameters:

pluginName - The name of your plugin. This is similar to the ID Name first part for CustomItems. For example: "additons_api" or "vanilla_additions".

entryName - The name of the entry.

getLang

public org.bukkit.configuration.file.YamlConfiguration getLang()

Returns:

A YamlConfiguration of the lang.yml file.

saveLang

public LangFile saveLang()

Saves the Lang File.

reloadLang

public LangFile reloadLang()

Reloads the Lang File, updating any changes.