Constructor Detail

• ConfigFile

  ConfigFile(JavaPlugin plugin, String fileName, Boolean useDataFolder)

  Parameters:

  plugin - The JavaPlugin extending class

  fileName - The name of the config file excluding file extensions.

Method Detail

• getConfig

   final FileConfiguration getConfig()

• setConfig

   final Unit setConfig(FileConfiguration config)

• getFile

   final File getFile()

• getFileName

   final String getFileName()

• getPath

   final Path getPath()

• createConfig

   final Boolean createConfig()

  This creates the configuration file. If the data folder is invalid, it will be created along with the config file.

• addIfDoesntExist

   final Unit addIfDoesntExist(String key, String value)

• addDefaults

   final Unit addDefaults(Map<String, Object> defaults)

  Parameters:

  defaults - A map containing the default configuration keys and values.

• save

   Unit save()

• reload

   Unit reload()

• deleteFile

   final Boolean deleteFile()

• deleteDir

   final Boolean deleteDir()

• reset

   final Unit reset()

• wipeDirectory

   final Unit wipeDirectory()

• createSubDirectory

   final Unit createSubDirectory(String name)

  Parameters:

  name - The sub-directory's name.

• contains

   final Boolean contains(String value, Boolean ignoreDefault)

  Parameters:

  value -

  • Check if it contains the string

  ignoreDefault -

  • Returns false if there is no set value, even if there is a default value

• saveDefaultConfig

   final Unit saveDefaultConfig()