desc | Standardized application folder setup; includes conf, cache, inputs, logs, outputs |
date | 2021-01-03 |
version | 2.0.0 |
jar | slatekit.common.jar |
namespace | slatekit.common.info |
artifact | com.slatekit:slatekit-common |
source folder | src/lib/kotlin/slatekit-common/src/main/kotlin/slatekit/common/info |
example | src/lib/kotlin/slate-examples/src/main/kotlin/slatekit/examples/Example_Folders.kt |
depends on | slatekit-results |
// other setup ...
repositories {
maven { url "https://dl.bintray.com/codehelixinc/slatekit" }
}
dependencies {
// other libraries
// slatekit-common: Utilities for Android or Server
compile 'com.slatekit:slatekit-common:0.9.35'
}
// required
import slatekit.common.info.Folders
// optional
import slatekit.results.Try
import slatekit.results.Success
import slatekit.cmds.Command
import slatekit.cmds.CommandRequest
n/a
// CASE 1: Build a folder structure for an application
// Explicitly indicate user-directory with the following folder structure
// NOTE: Slate Kit based applications are setup this way.
//
// /c/users/{user}/
// - company-1
// - department-1
// - app-1
// - conf
// - cache
// - inputs
// - logs
// - outputs
// - temp
val folders = Folders(
home = System.getProperty("user.dir"),
root = "company-1",
area = "department-1",
app = "app-1",
cache = "cache",
inputs = "input",
logs = "logs",
outputs = "output",
temp = "temp",
conf = "conf"
)
// CASE 2: Build a folder structure for an application
// Same as Case 1 above but using a short-hand approach
val folders2 = Folders.userDir(
root = "company-1",
area = "department-1",
app = "app-1"
)
// CASE 3: Create the folders if they do not exist
folders.create()
// CASE 4: Get the individual paths to the folders
println("app :" + folders.pathToApp)
println("cache :" + folders.pathToCache)
println("conf :" + folders.pathToConf)
println("input :" + folders.pathToInputs)
println("logs :" + folders.pathToLogs)
println("output :" + folders.pathToOutputs)
println("output :" + folders.pathToTemp)