Equinox/com.tecknobit.equinox.resourcesutils/ResourcesProvider

Resources Provider

The ResourcesProvider class is useful to create the resources directories and manage the main resources files such as the properties for the server

Author

N7ghtm4r3 - Tecknobit

Constructors

ResourcesProvider

constructor(containerDirectory: String)

Constructor to init the ResourcesProvider class

constructor(containerDirectory: String, subDirectories: List<String>)

Constructor to init the ResourcesProvider class

Properties

containerDirectory

protected val containerDirectory: String

containerDirectory the main container directory to create

containers

protected open var containers: HashSet<String>

containers the set of the containers folder which contains other subfolders to store the resources

CUSTOM_CONFIGURATION_FILE_PATH

val CUSTOM_CONFIGURATION_FILE_PATH: String = "custom.properties"

CUSTOM_CONFIGURATION_FILE_PATH the path of the custom server configuration file

DEFAULT_CONFIGURATION_FILE_PATH

val DEFAULT_CONFIGURATION_FILE_PATH: String = "app.properties"

DEFAULT_CONFIGURATION_FILE_PATH the default path where find the default server configuration

subDirectories

protected val subDirectories: List<String>

subDirectories the subdirectories of the containerDirectory folder

Functions

createContainerDirectory

open fun createContainerDirectory()

Method to create the containerDirectory No-any params required

open fun createContainerDirectory(containerDirectory: String)

Method to create a new container directory

createResourceDirectory

private open fun createResourceDirectory(resDirectory: String)

Method to create a new resource directory

createSubDirectories

open fun createSubDirectories()

Method to create the list of the subDirectories for the containerDirectory No-any params required

open fun createSubDirectories(containerDirectory: String, subDirectories: List<String>)

Method to create the list of the subDirectories for a container directory

createSubDirectory

open fun createSubDirectory(subDirectory: String)

Method to create a new subdirectory for the containerDirectory

open fun createSubDirectory(containerDirectory: String, subDirectory: String)

Method to create a new subdirectory

formatDirectory

private open fun formatDirectory(directory: String): String

Method to format the pathname of a directory

getContainers

open fun getContainers(): HashSet<String>

Method to get containers instance No-any params required

printError

private open fun printError(directory: String)

Method to print the error occurred during the creation of a resources directory