Package de.kelanisystem.kelaniconfig

Class KelaniConfigManager

java.lang.Object
de.kelanisystem.kelaniconfig.KelaniConfigManager
public class KelaniConfigManager
extends java.lang.Object

  • Constructor Summary

    Constructors 
    Constructor Description
    KelaniConfigManager()
    Creates new instance of the KelaniConfigManager Default configfolder is data/
    KelaniConfigManager​(java.nio.file.Path configFolder)
    Creates new instance of the KelaniConfigManager

  • Method Summary

    Modifier and Type Method Description
    void addDefault​(java.lang.String configName, java.lang.String key, java.lang.Object value)
    Copies a default into config.
    void addDefaults​(java.lang.String configName, java.util.Map<java.lang.String,​java.lang.Object> defaults)
    Copies multiple defaults into config.
    void copyDefaults​(java.lang.String configName, boolean bool)
    Sets copy defaults option and saves
    java.util.List<KelaniYamlFile> createFile​(java.lang.String... names)
    Creates config(s) default path
    java.util.List<KelaniYamlFile> createFile​(java.lang.String path, java.lang.String name)
    Creates config(s) with different path
    java.util.List<KelaniYamlFile> createFileWithOwnPath​(java.nio.file.Path path, java.lang.String... names)
    Creates config(s) with different path
    java.lang.Object get​(java.lang.String configName, java.lang.String key)
    Gets an object out of config
    java.lang.Boolean getBoolean​(java.lang.String configName, java.lang.String key)
    Gets an boolean out of config
    KelaniYamlFile getConfig​(java.lang.String configName)
    Returns configfile by name
    java.lang.Integer getInteger​(java.lang.String configName, java.lang.String key)
    Gets an integer out of config file
    java.util.List<java.lang.Integer> getIntegerList​(java.lang.String configName, java.lang.String key)
    Gets an integer list out of config
    java.util.List<?> getList​(java.lang.String configName, java.lang.String key)
    Gets an list out of config
    java.lang.String getString​(java.lang.String configName, java.lang.String key)
    Gets an string out of config
    java.util.List<java.lang.String> getStringList​(java.lang.String configName, java.lang.String key)
    Gets an string list out of config
    void save​(java.lang.String configName)
    Saves specific config
    void setHeader​(java.lang.String configName, java.lang.String header)
    Set header rows of the config.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • KelaniConfigManager

      public KelaniConfigManager()
      Creates new instance of the KelaniConfigManager Default configfolder is data/

    • KelaniConfigManager

      public KelaniConfigManager​(java.nio.file.Path configFolder)
      Creates new instance of the KelaniConfigManager
      Parameters:
      configFolder - default folder from configs

  • Method Details

    • createFile

      public java.util.List<KelaniYamlFile> createFile​(java.lang.String... names) throws java.io.IOException, org.simpleyaml.exceptions.InvalidConfigurationException
      Creates config(s) default path
      Parameters:
      names - of config(s) you want to create
      Returns:
      Configs you created
      Throws:
      java.io.IOException - On save
      org.simpleyaml.exceptions.InvalidConfigurationException - On load

    • createFile

      public java.util.List<KelaniYamlFile> createFile​(java.lang.String path, java.lang.String name) throws java.io.IOException, org.simpleyaml.exceptions.InvalidConfigurationException
      Creates config(s) with different path
      Parameters:
      name - of config(s) you want to create
      Returns:
      Configs you created
      Throws:
      java.io.IOException - On save
      org.simpleyaml.exceptions.InvalidConfigurationException - On load

    • createFileWithOwnPath

      public java.util.List<KelaniYamlFile> createFileWithOwnPath​(java.nio.file.Path path, java.lang.String... names) throws java.io.IOException, org.simpleyaml.exceptions.InvalidConfigurationException
      Creates config(s) with different path
      Parameters:
      names - of config(s) you want to create
      Returns:
      Configs you created
      Throws:
      java.io.IOException - On save
      org.simpleyaml.exceptions.InvalidConfigurationException - On load

    • getConfig

      public KelaniYamlFile getConfig​(java.lang.String configName)
      Returns configfile by name
      Parameters:
      configName - name of the config
      Returns:
      YamlConfiguration file

    • copyDefaults

      public void copyDefaults​(java.lang.String configName, boolean bool) throws java.io.IOException
      Sets copy defaults option and saves
      Parameters:
      configName - name of the config you want to edit
      bool - param of the option
      Throws:
      java.io.IOException - on save

    • addDefault

      public void addDefault​(java.lang.String configName, java.lang.String key, java.lang.Object value)
      Copies a default into config. Remember setting copy-defaults
      Parameters:
      configName - name of the config you want to edit
      key - key of default
      value - value of default

    • addDefaults

      public void addDefaults​(java.lang.String configName, java.util.Map<java.lang.String,​java.lang.Object> defaults)
      Copies multiple defaults into config. Remember setting copy defaults
      Parameters:
      configName - name of the config you want to edit
      defaults - defaults you want to set

    • get

      public java.lang.Object get​(java.lang.String configName, java.lang.String key)
      Gets an object out of config
      Parameters:
      configName - name of config you want to read
      key - key of the value you want to get
      Returns:
      value

    • getString

      public java.lang.String getString​(java.lang.String configName, java.lang.String key)
      Gets an string out of config
      Parameters:
      configName - name of config you want to read
      key - key of the value you want to get
      Returns:
      value

    • getBoolean

      public java.lang.Boolean getBoolean​(java.lang.String configName, java.lang.String key)
      Gets an boolean out of config
      Parameters:
      configName - name of config you want to read
      key - key of the value you want to get
      Returns:
      value

    • getInteger

      public java.lang.Integer getInteger​(java.lang.String configName, java.lang.String key)
      Gets an integer out of config file
      Parameters:
      configName - name of config you want to read
      key - key of the value you want to get
      Returns:
      value

    • getStringList

      public java.util.List<java.lang.String> getStringList​(java.lang.String configName, java.lang.String key)
      Gets an string list out of config
      Parameters:
      configName - name of config you want to read
      key - key of the value you want to get
      Returns:
      value

    • getIntegerList

      public java.util.List<java.lang.Integer> getIntegerList​(java.lang.String configName, java.lang.String key)
      Gets an integer list out of config
      Parameters:
      configName - name of config you want to read
      key - key of the value you want to get
      Returns:
      value

    • getList

      public java.util.List<?> getList​(java.lang.String configName, java.lang.String key)
      Gets an list out of config
      Parameters:
      configName - name of config you want to read
      key - key of the value you want to get
      Returns:
      value

    • setHeader

      public void setHeader​(java.lang.String configName, java.lang.String header) throws java.io.IOException
      Set header rows of the config. For comments in the file
      Parameters:
      configName - name of the config
      header - displayed text
      Throws:
      java.io.IOException - throws on save

    • save

      public void save​(java.lang.String configName) throws java.io.IOException
      Saves specific config
      Parameters:
      configName - name of the config
      Throws:
      java.io.IOException - throws on save