com.github.sbridges.ephemeralfs

Class EphemeralFsFileSystemBuilder

java.lang.Object

com.github.sbridges.ephemeralfs.EphemeralFsFileSystemBuilder

public final class EphemeralFsFileSystemBuilder
extends Object

Utility class to build an EphemeralFSFileSystem

Method Summary

Methods

Modifier and Type	Method and Description
FileSystem	build() Build a file system.
static EphemeralFsFileSystemBuilder	defaultFs() Build a file system that best matches the file system of the underlying operating system.
static EphemeralFsFileSystemBuilder	macFs() Build a mac like file system
EphemeralFsFileSystemBuilder	setMaxFileHandles(long maxFileHandles) If set, this limits the maximum number of open file handles.
EphemeralFsFileSystemBuilder	setName(String name) Set the name of this file system.
EphemeralFsFileSystemBuilder	setRecordStackTracesOnOpen(boolean recordStackTracesOnOpen) Record stack traces when opening resources such as FileChannels and DirectoryStreams.
EphemeralFsFileSystemBuilder	setTotalSpace(long totalSpace) If set, sets the total space available for this file system.
static EphemeralFsFileSystemBuilder	unixFs() Build a unix like file system
static EphemeralFsFileSystemBuilder	windowsFs() Build a windows like file system

Methods inherited from class java.lang.Object

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

Method Detail

defaultFs

public static EphemeralFsFileSystemBuilder defaultFs()

Build a file system that best matches the file system of the underlying operating system.

windowsFs

public static EphemeralFsFileSystemBuilder windowsFs()

Build a windows like file system

macFs

public static EphemeralFsFileSystemBuilder macFs()

Build a mac like file system

unixFs

public static EphemeralFsFileSystemBuilder unixFs()

Build a unix like file system

setRecordStackTracesOnOpen

public EphemeralFsFileSystemBuilder setRecordStackTracesOnOpen(boolean recordStackTracesOnOpen)

Record stack traces when opening resources such as FileChannels and DirectoryStreams.

The stack traces are available when calling EphemeralFsFileSystemChecker.assertNoOpenResources(FileSystem)

Defaults to true.

setName

public EphemeralFsFileSystemBuilder setName(String name)

Set the name of this file system. The name should be unique among open ephemeralFs file systems.

Defaults to a unique name.

setMaxFileHandles

public EphemeralFsFileSystemBuilder setMaxFileHandles(long maxFileHandles)

If set, this limits the maximum number of open file handles.

Defaults to Long.MAX_VALUE

setTotalSpace

public EphemeralFsFileSystemBuilder setTotalSpace(long totalSpace)

If set, sets the total space available for this file system.

Defaults to Long.MAX_VALUE

build

public FileSystem build()
                 throws IllegalStateException

Build a file system. This method can only be called once, subsequent calls will throw an IllegalStateException

Throws:

IllegalStateException