Package de.espirit.firstspirit.io

Interface FileSystemsAgent

public interface FileSystemsAgent

Agent providing means to access file systems.

Since:

5.1.42

Field Summary

Fields

Modifier and Type	Field	Description
static final SpecialistType<FileSystemsAgent>	TYPE	Agent providing means to access file systems.

Method Summary

Modifier and Type	Method	Description
FileSystem<? extends FileHandle>	getMemoryFileSystem()	Provides a memory-based file system instance.
FileSystem<? extends FileHandle>	getOSFileSystem(@NotNull String rootPath)	Provides an OS-based file system instance having the given path as root.
FileSystem<? extends FileHandle>	getRelativeFileSystem(@NotNull FileHandle root)	Provides a file system instance having the given root, which must represent a directory.

Field Details

TYPE

static final SpecialistType<FileSystemsAgent> TYPE

Agent providing means to access file systems.

Since:

5.1.42

Method Details

getMemoryFileSystem

FileSystem<? extends FileHandle> getMemoryFileSystem()

Provides a memory-based file system instance.

Returns:

A file system object.

Since:

5.1.42

getOSFileSystem

FileSystem<? extends FileHandle> getOSFileSystem(@NotNull
 @NotNull String rootPath)

Provides an OS-based file system instance having the given path as root.

Parameters:

rootPath - The root path for the file system.

Returns:

The according file system object.

Since:

5.1.42

getRelativeFileSystem

FileSystem<? extends FileHandle> getRelativeFileSystem(@NotNull
 @NotNull FileHandle root)
                                                throws IllegalArgumentException

Provides a file system instance having the given root, which must represent a directory.

Parameters:

root - The root of the file system.

Returns:

An according file system object.

Throws:

IllegalArgumentException - if the given root does not represent a directory.

Since:

5.1.42