ru.astrainteractive.astralibs.filemanager.FileManager.kt Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of core Show documentation

Core utilities for spigot development

There is a newer version: 3.14.1

package ru.astrainteractive.astralibs.filemanager

import java.io.File

/**
 * This class will help manage files
 * It will auto-create it inside [dataFolder] based on [name]
 */
interface FileManager {
    /**
     * Name of the file
     * Example: file.json; folder/nextfolder/file.json
     */
    val name: String

    /**
     * Path to data folder of the plugin
     */
    val dataFolder: File

    /**
     * Configuration file named [name] placed in [dataFolder]
     */
    val configFile: File

    /**
     * Delete [configFile]
     */
    fun delete()
}