All Implemented Interfaces:


public final class ConfigFile
extends DataFile

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private FileConfiguration`	`config`
`private final File`	`file`
`private final Path`	`path`

Constructor Summary

Constructors
Constructor	Description
`ConfigFile(JavaPlugin plugin, String fileName, Boolean useDataFolder)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final FileConfiguration`	`getConfig()`
`final Unit`	`setConfig(FileConfiguration config)`
`final File`	`getFile()`
`Path`	`getPath()`
`final Boolean`	`createConfig()`	This creates the configuration file.
`final Unit`	`addIfDoesntExist(String key, String value)`
`final Unit`	`addDefaults(Map<String, Object> defaults)`
`Unit`	`save()`
`Unit`	`reload()`
`final Boolean`	`deleteFile()`
`final Boolean`	`deleteDir()`
`final Unit`	`reset()`
`final Unit`	`wipeDirectory()`
`final Unit`	`createSubDirectory(String name)`
`final Boolean`	`contains(String value, Boolean ignoreDefault)`
`final Unit`	`saveDefaultConfig()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 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()
```
  - getPath
```
 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()
```

Class ConfigFile

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConfigFile

Method Detail

getConfig

setConfig

getFile

getPath

createConfig

addIfDoesntExist

addDefaults

save

reload

deleteFile

deleteDir

reset

wipeDirectory

createSubDirectory

contains

saveDefaultConfig