org.quiltmc.loader.api.QuiltFileSystems Class Reference

Factory methods for quilt's ExtendedFileSystem. More...

Classes
class	ExtendedFileSystemRef

Static Public Member Functions
static ExtendedFileSystemRef	createExtendedFileSystem (String name)
	Creates a new ExtendedFileSystem which stores all of its content in-memory.
static ExtendedFileSystemRef	loadZipFile (String name, Path zipFile) throws IOException
	Creates a new ExtendedFileSystem which loads zip file contents directly from the given file.
static ExtendedFileSystemRef	loadJarFile (String name, Path jarFile) throws IOException
	Creates a new ExtendedFileSystem which loads zip file contents directly from the given file, and mounts every multi-release jar entry.

Detailed Description

Factory methods for quilt's ExtendedFileSystem.

Member Function Documentation

createExtendedFileSystem()

ExtendedFileSystemRef org.quiltmc.loader.api.QuiltFileSystems.createExtendedFileSystem ( String name )

inlinestatic

Creates a new ExtendedFileSystem which stores all of its content in-memory.

The filesystem does not need to be explicitly closed, and calling FileSystem#close() will have no effect.

Parameters

name	A name for the file system, used for the URL and in logging. Invalid characters will be sanitized.

Returns

A reference to the file system

loadJarFile()

ExtendedFileSystemRef org.quiltmc.loader.api.QuiltFileSystems.loadJarFile ( String name, Path jarFile ) throws IOException

inlinestatic

Creates a new ExtendedFileSystem which loads zip file contents directly from the given file, and mounts every multi-release jar entry.

Parameters

name	A name for the file system, used for the URL and in logging. Invalid characters will be sanitized.
jarFile	A path to an existing file.

Returns

A reference to the file system.

Exceptions

IOException

if reading from the jar file failed.

loadZipFile()

ExtendedFileSystemRef org.quiltmc.loader.api.QuiltFileSystems.loadZipFile ( String name, Path zipFile ) throws IOException

inlinestatic

Creates a new ExtendedFileSystem which loads zip file contents directly from the given file.

This does NOT handle jar features like multi-release jars - for that you'll want to use loadJarFile(String, Path) instead.

Parameters

name	A name for the file system, used for the URL and in logging. Invalid characters will be sanitized.
zipFile	A path to an existing file.

Returns

A reference to the file system.

Exceptions

IOException

if reading from the zip file failed.

---

The documentation for this class was generated from the following file:

• src/main/java/org/quiltmc/loader/api/QuiltFileSystems.java