Simple Configuration class - Easily create, edit and save .yml files!

Simple YamlConfiguration Extension: Easily create new files

I have created a simple extenension class for YamlConfiguration which allows you to create new .yml files easily and quickly. It acts in the exact same way as any YamlConfiguration, but does not require you to go through a long tedious process when you want to create new configs.

Code:

Code:java

import java.io.File;
 
import org.bukkit.configuration.file.YamlConfiguration;
import org.bukkit.plugin.java.JavaPlugin;
 
public class Config extends YamlConfiguration{
 
    private JavaPlugin plugin;
    private String fileName;
 
    public Config(JavaPlugin plugin, String fileName){
        this.plugin = plugin;
        this.fileName = fileName + (fileName.endsWith(".yml") ? "" : ".yml");
 
        createFile();
    }
 
    private void createFile() {
        try {
            File file = new File(plugin.getDataFolder(), fileName);
            if (!file.exists()){
                if (plugin.getResource(fileName) != null){
                    plugin.saveResource(fileName, false);
                }else{
                    save(file);
                }
            }else{
                load(file);
                save(file);
            }
        } catch (Exception ex) {
            ex.printStackTrace();
        }
    }
 
    public void save(){
        try {
            save(new File(plugin.getDataFolder(), fileName));
        } catch (Exception ex) {
            ex.printStackTrace();
        }
    }
}
 

If the file already exists, it will load that file and use it. If the file does not exist on the disk but does exist as a resource within the plugin, it will use that resource and save it. Otherwise, it will create an entirely new file and use that.

Remember, this class is an extension of YamlConfiguration. This means you can use all of YamlConfiguration's methods, like you would from your Plugin's default config. If you want to save any changes you make to a config, you must use the .save(); method.

Usage:

Code:java

Config config = new Config(this, "config"); //Get the plugin's default config.yml file
config.set("test", "Hello world!");
config.save(); //Save and write changes made to the config.
 
String hello = config.getString("test"); //Retrieve the string stored at the path "test" in the config.
 
for (Player player : Bukkit.getOnlinePlayers()){
    Config playerConfig = new Config(this, "Players" + File.separator + player.getName());
    playerConfig.set("name", player.getName());
    playerConfig.save();
}
//Creates a collection of .yml files in a new Players folder, for all online players, and stores their location.
//Note, this is an example, remember that Bukkit is now supporting UUIDs, so use player.getUniqueID() if you want to make any further use of this.

If you notice any errors or issues with this code, please let me know. You may use this code freely as long as you give credit to me!

 

Why are there two save methods and no set?

 

dsouzamatt
I updated the main post so that it's a little less confusing.

 

Dragonphase Ah, I see. Yeah, that makes sense now.

 

Dragonphase
Very nice resource. I may use this (with due credit, of course).

 

Dragonphase
Great resource but is there any way to use this in a JoinListener class as well? I keep getting a load of errors when I try to reference to it.

 

TheYajrab
Then you're referencing it wrong.

 

You might want to allow different files extensions, as YamlConfiguration can handle more than just .yml.

 

Phasesaber

Anyone can alter the class to do this.