Updated to 4.1.0

eco-util/src/main/java/com/willfp/eco/internal/config/AbstractConfig.java

@@ -1,15 +1,11 @@
 package com.willfp.eco.internal.config;
 
-import com.willfp.eco.util.StringUtils;
-import com.willfp.eco.util.internal.PluginDependent;
 import com.willfp.eco.util.plugin.AbstractEcoPlugin;
 import lombok.AccessLevel;
 import lombok.Getter;
-import org.bukkit.configuration.ConfigurationSection;
 import org.bukkit.configuration.InvalidConfigurationException;
 import org.bukkit.configuration.file.YamlConfiguration;
 import org.jetbrains.annotations.NotNull;
-import org.jetbrains.annotations.Nullable;
 
 import java.io.BufferedReader;
 import java.io.File;
@@ -19,31 +15,14 @@ import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.io.OutputStream;
 import java.nio.charset.StandardCharsets;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-import java.util.Objects;
-
-@SuppressWarnings("unchecked")
-public abstract class AbstractConfig extends PluginDependent {
-    /**
-     * The linked {@link YamlConfiguration} where values are physically stored.
-     */
-    @Getter(AccessLevel.PUBLIC)
-    protected final YamlConfiguration config;
 
+public abstract class AbstractConfig extends AbstractUndefinedConfig {
     /**
      * The physical config file, as stored on disk.
      */
     @Getter(AccessLevel.PROTECTED)
     private final File configFile;
 
-    /**
-     * The full name of the config file (eg config.yml).
-     */
-    @Getter(AccessLevel.PROTECTED)
-    private final String name;
-
     /**
      * The subdirectory path.
      */
@@ -56,11 +35,6 @@ public abstract class AbstractConfig extends PluginDependent {
     @Getter(AccessLevel.PROTECTED)
     private final Class<?> source;
 
-    /**
-     * Cached values for faster reading.
-     */
-    private final Map<String, Object> cache = new HashMap<>();
-
     /**
      * Abstract config.
      *
@@ -73,22 +47,21 @@ public abstract class AbstractConfig extends PluginDependent {
                              @NotNull final AbstractEcoPlugin plugin,
                              @NotNull final String subDirectoryPath,
                              @NotNull final Class<?> source) {
-        super(plugin);
+        super(configName, plugin);
         this.source = source;
         this.subDirectoryPath = subDirectoryPath;
-        this.name = configName + ".yml";
 
         File directory = new File(this.getPlugin().getDataFolder(), subDirectoryPath);
         if (!directory.exists()) {
             directory.mkdirs();
         }
 
-        if (!new File(directory, this.name).exists()) {
+        if (!new File(directory, this.getName()).exists()) {
             createFile();
         }
 
-        this.configFile = new File(directory, this.name);
-        this.config = YamlConfiguration.loadConfiguration(configFile);
+        this.configFile = new File(directory, this.getName());
+        init(YamlConfiguration.loadConfiguration(configFile));
     }
 
     private void createFile() {
@@ -127,9 +100,9 @@ public abstract class AbstractConfig extends PluginDependent {
         String resourcePath;
 
         if (subDirectoryPath.isEmpty()) {
-            resourcePath = name;
+            resourcePath = this.getName();
         } else {
-            resourcePath = subDirectoryPath + name;
+            resourcePath = subDirectoryPath + this.getName();
         }
 
         return "/" + resourcePath;
@@ -158,315 +131,4 @@ public abstract class AbstractConfig extends PluginDependent {
 
         return newConfig;
     }
-
-    /**
-     * Clears cache.
-     */
-    public final void clearCache() {
-        cache.clear();
-    }
-
-    /**
-     * Get if the config contains a key.
-     *
-     * @param path The key to check.
-     * @return If contained.
-     */
-    public boolean has(@NotNull final String path) {
-        return config.contains(path);
-    }
-
-    /**
-     * Get configuration section from config.
-     *
-     * @param path The key to check.
-     * @return The configuration section. Throws NPE if not found.
-     */
-    @NotNull
-    public ConfigurationSection getSection(@NotNull final String path) {
-        ConfigurationSection section = getSectionOrNull(path);
-        if (section == null) {
-            throw new NullPointerException("Section cannot be null!");
-        } else {
-            return section;
-        }
-    }
-
-    /**
-     * Get configuration section from config.
-     *
-     * @param path The key to check.
-     * @return The configuration section, or null if not found.
-     */
-    @Nullable
-    public ConfigurationSection getSectionOrNull(@NotNull final String path) {
-        if (cache.containsKey(path)) {
-            return (ConfigurationSection) cache.get(path);
-        } else {
-            cache.put(path, config.getConfigurationSection(path));
-            return getSectionOrNull(path);
-        }
-    }
-
-    /**
-     * Get an integer from config.
-     *
-     * @param path The key to fetch the value from.
-     * @return The found value, or 0 if not found.
-     */
-    public int getInt(@NotNull final String path) {
-        if (cache.containsKey(path)) {
-            return (int) cache.get(path);
-        } else {
-            cache.put(path, config.getInt(path, 0));
-            return getInt(path);
-        }
-    }
-
-    /**
-     * Get an integer from config.
-     *
-     * @param path The key to fetch the value from.
-     * @return The found value, or null if not found.
-     */
-    @Nullable
-    public Integer getIntOrNull(@NotNull final String path) {
-        if (has(path)) {
-            return getInt(path);
-        } else {
-            return null;
-        }
-    }
-
-    /**
-     * Get an integer from config with a specified default (not found) value.
-     *
-     * @param path The key to fetch the value from.
-     * @param def  The value to default to if not found.
-     * @return The found value, or the default.
-     */
-    public int getInt(@NotNull final String path,
-                      final int def) {
-        if (cache.containsKey(path)) {
-            return (int) cache.get(path);
-        } else {
-            cache.put(path, config.getInt(path, def));
-            return getInt(path);
-        }
-    }
-
-    /**
-     * Get a list of integers from config.
-     *
-     * @param path The key to fetch the value from.
-     * @return The found value, or a blank {@link java.util.ArrayList} if not found.
-     */
-    @NotNull
-    public List<Integer> getInts(@NotNull final String path) {
-        if (cache.containsKey(path)) {
-            return (List<Integer>) cache.get(path);
-        } else {
-            cache.put(path, config.getIntegerList(path));
-            return getInts(path);
-        }
-    }
-
-    /**
-     * Get a list of integers from config.
-     *
-     * @param path The key to fetch the value from.
-     * @return The found value, or null if not found.
-     */
-    @Nullable
-    public List<Integer> getIntsOrNull(@NotNull final String path) {
-        if (has(path)) {
-            return getInts(path);
-        } else {
-            return null;
-        }
-    }
-
-    /**
-     * Get a boolean from config.
-     *
-     * @param path The key to fetch the value from.
-     * @return The found value, or false if not found.
-     */
-    public boolean getBool(@NotNull final String path) {
-        if (cache.containsKey(path)) {
-            return (boolean) cache.get(path);
-        } else {
-            cache.put(path, config.getBoolean(path));
-            return getBool(path);
-        }
-    }
-
-    /**
-     * Get a boolean from config.
-     *
-     * @param path The key to fetch the value from.
-     * @return The found value, or null if not found.
-     */
-    @Nullable
-    public Boolean getBoolOrNull(@NotNull final String path) {
-        if (has(path)) {
-            return getBool(path);
-        } else {
-            return null;
-        }
-    }
-
-    /**
-     * Get a list of booleans from config.
-     *
-     * @param path The key to fetch the value from.
-     * @return The found value, or a blank {@link java.util.ArrayList} if not found.
-     */
-    @NotNull
-    public List<Boolean> getBools(@NotNull final String path) {
-        if (cache.containsKey(path)) {
-            return (List<Boolean>) cache.get(path);
-        } else {
-            cache.put(path, config.getBooleanList(path));
-            return getBools(path);
-        }
-    }
-
-    /**
-     * Get a list of booleans from config.
-     *
-     * @param path The key to fetch the value from.
-     * @return The found value, or null if not found.
-     */
-    @Nullable
-    public List<Boolean> getBoolsOrNull(@NotNull final String path) {
-        if (has(path)) {
-            return getBools(path);
-        } else {
-            return null;
-        }
-    }
-
-    /**
-     * Get a string from config.
-     *
-     * @param path The key to fetch the value from.
-     * @return The found value, or an empty string if not found.
-     */
-    @NotNull
-    public String getString(@NotNull final String path) {
-        if (cache.containsKey(path)) {
-            return (String) cache.get(path);
-        } else {
-            cache.put(path, StringUtils.translate(Objects.requireNonNull(config.getString(path, ""))));
-            return getString(path);
-        }
-    }
-
-    /**
-     * Get a string from config.
-     *
-     * @param path The key to fetch the value from.
-     * @return The found value, or null if not found.
-     */
-    @Nullable
-    public String getStringOrNull(@NotNull final String path) {
-        if (has(path)) {
-            return getString(path);
-        } else {
-            return null;
-        }
-    }
-
-    /**
-     * Get a list of strings from config.
-     *
-     * @param path The key to fetch the value from.
-     * @return The found value, or a blank {@link java.util.ArrayList} if not found.
-     */
-    @NotNull
-    public List<String> getStrings(@NotNull final String path) {
-        if (cache.containsKey(path)) {
-            return (List<String>) cache.get(path);
-        } else {
-            cache.put(path, config.getStringList(path));
-            return getStrings(path);
-        }
-    }
-
-    /**
-     * Get a list of strings from config.
-     *
-     * @param path The key to fetch the value from.
-     * @return The found value, or null if not found.
-     */
-    @Nullable
-    public List<String> getStringsOrNull(@NotNull final String path) {
-        if (has(path)) {
-            return getStrings(path);
-        } else {
-            return null;
-        }
-    }
-
-    /**
-     * Get a decimal from config.
-     *
-     * @param path The key to fetch the value from.
-     * @return The found value, or 0 if not found.
-     */
-    public double getDouble(@NotNull final String path) {
-        if (cache.containsKey(path)) {
-            return (double) cache.get(path);
-        } else {
-            cache.put(path, config.getDouble(path));
-            return getDouble(path);
-        }
-    }
-
-    /**
-     * Get a decimal from config.
-     *
-     * @param path The key to fetch the value from.
-     * @return The found value, or null if not found.
-     */
-    @Nullable
-    public Double getDoubleOrNull(@NotNull final String path) {
-        if (has(path)) {
-            return getDouble(path);
-        } else {
-            return null;
-        }
-    }
-
-    /**
-     * Get a list of decimals from config.
-     *
-     * @param path The key to fetch the value from.
-     * @return The found value, or a blank {@link java.util.ArrayList} if not found.
-     */
-    @NotNull
-    public List<Double> getDoubles(@NotNull final String path) {
-        if (cache.containsKey(path)) {
-            return (List<Double>) cache.get(path);
-        } else {
-            cache.put(path, config.getDoubleList(path));
-            return getDoubles(path);
-        }
-    }
-
-    /**
-     * Get a list of decimals from config.
-     *
-     * @param path The key to fetch the value from.
-     * @return The found value, or null if not found.
-     */
-    @Nullable
-    public List<Double> getDoublesOrNull(@NotNull final String path) {
-        if (has(path)) {
-            return getDoubles(path);
-        } else {
-            return null;
-        }
-    }
 }

eco-util/src/main/java/com/willfp/eco/internal/config/AbstractUndefinedConfig.java

@@ -0,0 +1,363 @@
+package com.willfp.eco.internal.config;
+
+import com.willfp.eco.util.StringUtils;
+import com.willfp.eco.util.internal.PluginDependent;
+import com.willfp.eco.util.plugin.AbstractEcoPlugin;
+import lombok.AccessLevel;
+import lombok.Getter;
+import org.bukkit.configuration.ConfigurationSection;
+import org.bukkit.configuration.file.YamlConfiguration;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Objects;
+
+@SuppressWarnings({"unchecked", "unused"})
+public abstract class AbstractUndefinedConfig extends PluginDependent {
+    /**
+     * The linked {@link YamlConfiguration} where values are physically stored.
+     */
+    @Getter(AccessLevel.PUBLIC)
+    protected YamlConfiguration config = null;
+
+    /**
+     * The full name of the config file (eg config.yml).
+     */
+    @Getter(AccessLevel.PROTECTED)
+    private final String name;
+
+    /**
+     * Cached values for faster reading.
+     */
+    private final Map<String, Object> cache = new HashMap<>();
+
+    /**
+     * Abstract config.
+     *
+     * @param configName The name of the config
+     * @param plugin     The plugin.
+     */
+    protected AbstractUndefinedConfig(@NotNull final String configName,
+                                      @NotNull final AbstractEcoPlugin plugin) {
+        super(plugin);
+        this.name = configName + ".yml";
+    }
+
+    protected void init(@NotNull final YamlConfiguration config) {
+        this.config = config;
+    }
+
+    /**
+     * Clears cache.
+     */
+    public final void clearCache() {
+        cache.clear();
+    }
+
+    /**
+     * Get if the config contains a key.
+     *
+     * @param path The key to check.
+     * @return If contained.
+     */
+    public boolean has(@NotNull final String path) {
+        return config.contains(path);
+    }
+
+    /**
+     * Get configuration section from config.
+     *
+     * @param path The key to check.
+     * @return The configuration section. Throws NPE if not found.
+     */
+    @NotNull
+    public ConfigurationSection getSection(@NotNull final String path) {
+        ConfigurationSection section = getSectionOrNull(path);
+        if (section == null) {
+            throw new NullPointerException("Section cannot be null!");
+        } else {
+            return section;
+        }
+    }
+
+    /**
+     * Get configuration section from config.
+     *
+     * @param path The key to check.
+     * @return The configuration section, or null if not found.
+     */
+    @Nullable
+    public ConfigurationSection getSectionOrNull(@NotNull final String path) {
+        if (cache.containsKey(path)) {
+            return (ConfigurationSection) cache.get(path);
+        } else {
+            cache.put(path, config.getConfigurationSection(path));
+            return getSectionOrNull(path);
+        }
+    }
+
+    /**
+     * Get an integer from config.
+     *
+     * @param path The key to fetch the value from.
+     * @return The found value, or 0 if not found.
+     */
+    public int getInt(@NotNull final String path) {
+        if (cache.containsKey(path)) {
+            return (int) cache.get(path);
+        } else {
+            cache.put(path, config.getInt(path, 0));
+            return getInt(path);
+        }
+    }
+
+    /**
+     * Get an integer from config.
+     *
+     * @param path The key to fetch the value from.
+     * @return The found value, or null if not found.
+     */
+    @Nullable
+    public Integer getIntOrNull(@NotNull final String path) {
+        if (has(path)) {
+            return getInt(path);
+        } else {
+            return null;
+        }
+    }
+
+    /**
+     * Get an integer from config with a specified default (not found) value.
+     *
+     * @param path The key to fetch the value from.
+     * @param def  The value to default to if not found.
+     * @return The found value, or the default.
+     */
+    public int getInt(@NotNull final String path,
+                      final int def) {
+        if (cache.containsKey(path)) {
+            return (int) cache.get(path);
+        } else {
+            cache.put(path, config.getInt(path, def));
+            return getInt(path);
+        }
+    }
+
+    /**
+     * Get a list of integers from config.
+     *
+     * @param path The key to fetch the value from.
+     * @return The found value, or a blank {@link java.util.ArrayList} if not found.
+     */
+    @NotNull
+    public List<Integer> getInts(@NotNull final String path) {
+        if (cache.containsKey(path)) {
+            return (List<Integer>) cache.get(path);
+        } else {
+            cache.put(path, config.getIntegerList(path));
+            return getInts(path);
+        }
+    }
+
+    /**
+     * Get a list of integers from config.
+     *
+     * @param path The key to fetch the value from.
+     * @return The found value, or null if not found.
+     */
+    @Nullable
+    public List<Integer> getIntsOrNull(@NotNull final String path) {
+        if (has(path)) {
+            return getInts(path);
+        } else {
+            return null;
+        }
+    }
+
+    /**
+     * Get a boolean from config.
+     *
+     * @param path The key to fetch the value from.
+     * @return The found value, or false if not found.
+     */
+    public boolean getBool(@NotNull final String path) {
+        if (cache.containsKey(path)) {
+            return (boolean) cache.get(path);
+        } else {
+            cache.put(path, config.getBoolean(path));
+            return getBool(path);
+        }
+    }
+
+    /**
+     * Get a boolean from config.
+     *
+     * @param path The key to fetch the value from.
+     * @return The found value, or null if not found.
+     */
+    @Nullable
+    public Boolean getBoolOrNull(@NotNull final String path) {
+        if (has(path)) {
+            return getBool(path);
+        } else {
+            return null;
+        }
+    }
+
+    /**
+     * Get a list of booleans from config.
+     *
+     * @param path The key to fetch the value from.
+     * @return The found value, or a blank {@link java.util.ArrayList} if not found.
+     */
+    @NotNull
+    public List<Boolean> getBools(@NotNull final String path) {
+        if (cache.containsKey(path)) {
+            return (List<Boolean>) cache.get(path);
+        } else {
+            cache.put(path, config.getBooleanList(path));
+            return getBools(path);
+        }
+    }
+
+    /**
+     * Get a list of booleans from config.
+     *
+     * @param path The key to fetch the value from.
+     * @return The found value, or null if not found.
+     */
+    @Nullable
+    public List<Boolean> getBoolsOrNull(@NotNull final String path) {
+        if (has(path)) {
+            return getBools(path);
+        } else {
+            return null;
+        }
+    }
+
+    /**
+     * Get a string from config.
+     *
+     * @param path The key to fetch the value from.
+     * @return The found value, or an empty string if not found.
+     */
+    @NotNull
+    public String getString(@NotNull final String path) {
+        if (cache.containsKey(path)) {
+            return (String) cache.get(path);
+        } else {
+            cache.put(path, StringUtils.translate(Objects.requireNonNull(config.getString(path, ""))));
+            return getString(path);
+        }
+    }
+
+    /**
+     * Get a string from config.
+     *
+     * @param path The key to fetch the value from.
+     * @return The found value, or null if not found.
+     */
+    @Nullable
+    public String getStringOrNull(@NotNull final String path) {
+        if (has(path)) {
+            return getString(path);
+        } else {
+            return null;
+        }
+    }
+
+    /**
+     * Get a list of strings from config.
+     *
+     * @param path The key to fetch the value from.
+     * @return The found value, or a blank {@link java.util.ArrayList} if not found.
+     */
+    @NotNull
+    public List<String> getStrings(@NotNull final String path) {
+        if (cache.containsKey(path)) {
+            return (List<String>) cache.get(path);
+        } else {
+            cache.put(path, config.getStringList(path));
+            return getStrings(path);
+        }
+    }
+
+    /**
+     * Get a list of strings from config.
+     *
+     * @param path The key to fetch the value from.
+     * @return The found value, or null if not found.
+     */
+    @Nullable
+    public List<String> getStringsOrNull(@NotNull final String path) {
+        if (has(path)) {
+            return getStrings(path);
+        } else {
+            return null;
+        }
+    }
+
+    /**
+     * Get a decimal from config.
+     *
+     * @param path The key to fetch the value from.
+     * @return The found value, or 0 if not found.
+     */
+    public double getDouble(@NotNull final String path) {
+        if (cache.containsKey(path)) {
+            return (double) cache.get(path);
+        } else {
+            cache.put(path, config.getDouble(path));
+            return getDouble(path);
+        }
+    }
+
+    /**
+     * Get a decimal from config.
+     *
+     * @param path The key to fetch the value from.
+     * @return The found value, or null if not found.
+     */
+    @Nullable
+    public Double getDoubleOrNull(@NotNull final String path) {
+        if (has(path)) {
+            return getDouble(path);
+        } else {
+            return null;
+        }
+    }
+
+    /**
+     * Get a list of decimals from config.
+     *
+     * @param path The key to fetch the value from.
+     * @return The found value, or a blank {@link java.util.ArrayList} if not found.
+     */
+    @NotNull
+    public List<Double> getDoubles(@NotNull final String path) {
+        if (cache.containsKey(path)) {
+            return (List<Double>) cache.get(path);
+        } else {
+            cache.put(path, config.getDoubleList(path));
+            return getDoubles(path);
+        }
+    }
+
+    /**
+     * Get a list of decimals from config.
+     *
+     * @param path The key to fetch the value from.
+     * @return The found value, or null if not found.
+     */
+    @Nullable
+    public List<Double> getDoublesOrNull(@NotNull final String path) {
+        if (has(path)) {
+            return getDoubles(path);
+        } else {
+            return null;
+        }
+    }
+}

eco-util/src/main/java/com/willfp/eco/util/config/StaticOptionalConfig.java

@@ -0,0 +1,25 @@
+package com.willfp.eco.util.config;
+
+import com.willfp.eco.internal.config.AbstractUndefinedConfig;
+import com.willfp.eco.util.plugin.AbstractEcoPlugin;
+import org.bukkit.configuration.file.YamlConfiguration;
+import org.jetbrains.annotations.NotNull;
+
+public abstract class StaticOptionalConfig extends AbstractUndefinedConfig {
+    /**
+     * Config implementation for passing YamlConfigurations.
+     * <p>
+     * Does not automatically update.
+     *
+     * @param configName The name of the config
+     * @param plugin     The plugin.
+     * @param config     The YamlConfiguration handle.
+     */
+    public StaticOptionalConfig(@NotNull final String configName,
+                                @NotNull final AbstractEcoPlugin plugin,
+                                @NotNull final YamlConfiguration config) {
+        super(configName, plugin);
+
+        init(config);
+    }
+}

gradle.properties

@@ -1,2 +1,2 @@
-version = 4.0.0
+version = 4.1.0
 plugin-name = eco