Class FileIO

java.lang.Object

de.luckymcdev.foundryengine.util.common.FileIO

public class FileIO
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	FileIO.FileMetadata

Constructor Summary

Constructors

Constructor	Description
FileIO()

Method Summary

Modifier and Type	Method	Description
static void	appendText(Path path, String content)
static void	copy(Path source, Path target)	Copies a file, or a whole directory tree.
static void	createZip(Path sourceDir, Path zipPath)	Zips a directory.
static void	createZipFromFiles(List<Path> files, Path zipPath)	Zips individual files flat (by file name).
static boolean	delete(Path path)	Deletes a file, or a directory including its contents.
static void	deleteDirectory(Path path)
static void	download(String url, Path destPath)	Downloads to a temp file next to destPath and moves it into place on success, so a failed download never leaves a partial file or destroys an existing one.
static boolean	exists(Path path)	True if a file OR directory exists at path.
static void	extractZip(Path zipPath, Path destDir)
static void	extractZipDirectory(Path zipPath, String dirEntry, Path destDir)	Extracts everything below dirEntry (e.g.
static Path	gameDir()
static boolean	isDirectory(Path path)
static boolean	isFile(Path path)
static List<Path>	list(Path path)
static List<Path>	listRecursive(Path path)	Lists all regular files below path.
static List<String>	listZip(Path zipPath)
static FileIO.FileMetadata	metadata(Path path)
static void	mkdirs(Path path)
static byte[]	readBytes(Path path)
static List<String>	readLines(Path path)
static String	readText(Path path)
static String	readZipEntry(Path zipPath, String entryName)
static byte[]	readZipEntryBytes(Path zipPath, String entryName)
static Path	resolve(String path)
static void	saveZipEntry(Path zipPath, String entryName, Path destPath)	Extracts a single entry to destPath.
static void	writeBytes(Path path, byte[] bytes)
static void	writeText(Path path, String content)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FileIO

public FileIO()

Method Details

gameDir

public static Path gameDir()

resolve

public static Path resolve(String path)
                    throws IOException

Throws:

IOException

readText

public static String readText(Path path)
                       throws IOException

Throws:

IOException

readLines

public static List<String> readLines(Path path)
                              throws IOException

Throws:

IOException

writeText

public static void writeText(Path path,
 String content)
                      throws IOException

Throws:

IOException

appendText

public static void appendText(Path path,
 String content)
                       throws IOException

Throws:

IOException

readBytes

public static byte[] readBytes(Path path)
                        throws IOException

Throws:

IOException

writeBytes

public static void writeBytes(Path path,
 byte[] bytes)
                       throws IOException

Throws:

IOException

copy

public static void copy(Path source,
 Path target)
                 throws IOException

Copies a file, or a whole directory tree. For directories the contents of source are merged into target (existing files are replaced). Symbolic links inside a copied tree are skipped.

Throws:

IOException

delete

public static boolean delete(Path path)
                      throws IOException

Deletes a file, or a directory including its contents. A symbolic link is removed without touching what it points to.

Returns:

true if something was deleted

Throws:

IOException

deleteDirectory

public static void deleteDirectory(Path path)
                            throws IOException

Throws:

IOException

mkdirs

public static void mkdirs(Path path)
                   throws IOException

Throws:

IOException

list

public static List<Path> list(Path path)
                       throws IOException

Throws:

IOException

listRecursive

public static List<Path> listRecursive(Path path)
                                throws IOException

Lists all regular files below path.

Throws:

IOException

exists

public static boolean exists(Path path)
                      throws IOException

True if a file OR directory exists at path.

Throws:

IOException

isFile

public static boolean isFile(Path path)
                      throws IOException

Throws:

IOException

isDirectory

public static boolean isDirectory(Path path)
                           throws IOException

Throws:

IOException

metadata

public static FileIO.FileMetadata metadata(Path path)
                                    throws IOException

Throws:

IOException

createZip

public static void createZip(Path sourceDir,
 Path zipPath)
                      throws IOException

Zips a directory. Empty directories are kept; the zip itself is never included.

Throws:

IOException

createZipFromFiles

public static void createZipFromFiles(List<Path> files,
 Path zipPath)
                               throws IOException

Zips individual files flat (by file name). Two files with the same name are rejected.

Throws:

IOException

listZip

public static List<String> listZip(Path zipPath)
                            throws IOException

Throws:

IOException

readZipEntry

public static String readZipEntry(Path zipPath,
 String entryName)
                           throws IOException

Throws:

IOException

readZipEntryBytes

public static byte[] readZipEntryBytes(Path zipPath,
 String entryName)
                                throws IOException

Throws:

IOException

extractZip

public static void extractZip(Path zipPath,
 Path destDir)
                       throws IOException

Throws:

IOException

extractZipDirectory

public static void extractZipDirectory(Path zipPath,
 String dirEntry,
 Path destDir)
                                throws IOException

Extracts everything below dirEntry (e.g. "level/") into destDir, with the dirEntry prefix stripped. An empty dirEntry extracts the whole zip.

Throws:

IOException

saveZipEntry

public static void saveZipEntry(Path zipPath,
 String entryName,
 Path destPath)
                         throws IOException

Extracts a single entry to destPath. If entryName refers to a directory ("level" or "level/"), its contents are extracted into destPath.

Throws:

IOException

download

public static void download(String url,
 Path destPath)
                     throws IOException

Downloads to a temp file next to destPath and moves it into place on success, so a failed download never leaves a partial file or destroys an existing one.

Throws:

IOException