FileManager

Services.get("FileManager")

Overview:

Functions:
fileExists(path) ⇒ boolean
read(path) ⇒ string
write(path, data) ⇒ ResultMap
createFile(path) ⇒ File
createFolder(path) ⇒ ResultMap
getFiles(path) ⇒ List [File or Folder]
getFile(path) ⇒ File
getFolder(path) ⇒ File
removeFile(path) ⇒ boolean
removeFolder(path) ⇒ boolean
listenOnPath(path, listenerType, function)
clearFileListeners()

The working directory is automatically the parent folder of the current script!

API Reference

fileExists()

Returns true if the file exists or false if it does not exist or is inaccessible.

fileManager.fileExists("config.json")

Parameters:

• path (String)

Returns Boolean.

---

read()

Returns the data of a readable file (in String) if successfully ran.

let data = fileManager.read("config.json")

Parameters:

• path (String)

Returns String.

---

write()

Writes the data (in String) on the file, overwriting its previous data.

fileManager.write("config.json", "{}")

Parameters:

• path (String)

• data (String) ⇒ The content that will be written to the file

Returns:

{success, error} => {"Success" | "Error", true | "Error reason"}

---

createFile()

Creates a file (if it does not exist) on the specified path. Use forward slashes "/" to jump to folders.

fileManager.createFile("config.json")

Parameters:

• path (String)

Returns: java.io.File

---

createFolder()

Creates a folder (if it does not exist) on the specified path. Use forward slashes "/" to jump to folders.

fileManager.createFolder("Configuration")

Parameters:

• path (String)

Returns:

{success, error} => {"Success" | "Error", true | "Error reason"}

---

getFiles()

Returns a list of all files within the specified path.

FileManager.getFiles("/");

Parameters:

• path (String)

Returns:

[Files]

Example usage:

Print all files that are in the current folder of the script

const fileManager = Services.get("FileManager");
const files = fileManager.getFiles("/");

for (let file of files) {
    print("Found file: " + file.getName());
}

---

getFile()

Returns a file (if it does exist) on the specified path.

fileManager.getFile("config.json")

Parameters:

• path (String)

Returns: java.io.File

---

getFolder()

Returns a folder (if it does exist) on the specified path.

fileManager.getFolder("configs")

Parameters:

• path (String)

Returns: java.io.File

---

removeFile()

Removes the file.

fileManager.removeFile("example.txt")

Parameters:

• path (String)

Returns: Boolean

---

removeFolder()

Removes the folder.

fileManager.removeFolder("example")

Parameters:

• path (String)

Returns: Boolean

---

listenOnPath()

Allows scripts to listen for file changes on the specified path.

fileManager.listenOnPath("ExampleFolder", "ENTRY_CREATE", function(File, EventType) {
    log.info(File.getName())
    log.info(EventType)
})

Parameters:

• path (String)

• listenerType (String) ⇒ "ENTRY_CREATE" When a file gets added/created ⇒ "ENTRY_DELETE" When a file gets removed/moved ⇒ "ENTRY_MODIFY" When a file gets modified/edited

Returns ^{_{(function handler)}}:

• File java.io.File

• Event Type "ENTRY_CREATE" or "ENTRY_DELETE" or "ENTRY_MODIFY"

---

clearFileListeners()

Removes all of the file listeners created by the current script.

fileManager.clearFileListeners()

---

Example:

Create folder with listener example

let FileManager = Services.get("FileManager");
let FolderName = "SomeFiles"

FileManager.createFolder(FolderName)
FileManager.listenOnPath(FolderName, "ENTRY_CREATE", function(File) {
    log.info(File.getName() + " has been created")
})
FileManager.listenOnPath(FolderName, "ENTRY_DELETE", function(File) {
    log.info(File.getName() + " has been removed")
})
FileManager.listenOnPath(FolderName, "ENTRY_MODIFY", function(File) {
    log.info(File.getName() + " has been changed")
    log.info("It contains the following data: " + FileManager.read(FolderName + "/" + File.getName()))
})