com.meterware.simplestub.stubs

Class InMemoryFileSystem

java.lang.Object

java.nio.file.FileSystem

com.meterware.simplestub.stubs.InMemoryFileSystem

All Implemented Interfaces:

Closeable, AutoCloseable

public abstract class InMemoryFileSystem
extends FileSystem

A Test stub for the NIO file system. This enables unit tests to create files in memory, and access them using the Files class. The methods rely on a Path value, normally created by calling Paths.get(String, String...). In a unit test, you would instead call getPath(String, String...). Currently, the following methods are supported: <ul> <li>Files.exists(Path, LinkOption...) <li>Files.lines(Path) <li>Files.lines(Path, Charset) <li>Files.newBufferedReader(Path) <li>Files.newBufferedReader(Path, Charset) <li>Files.newInputStream(Path, OpenOption...) <li>Files.notExists(Path, LinkOption...) <li>Files.readAllBytes(Path) <li>Files.readAllLines(Path) <li>Files.readAllLines(Path, Charset) </ul>

Constructor Summary

Constructors

Constructor and Description
InMemoryFileSystem()

Method Summary

Modifier and Type	Method and Description
static InMemoryFileSystem	createInstance() Creates an instance for a test.
void	defineFile(String filePath, byte... contents) Defines the contents for an in-memory file.
void	defineFile(String filePath, String contents) Defines the contents for an in-memory file.
void	defineFile(String filePath, String contents, String charset) Defines the contents for an in-memory file.
Path	getPath(String first, String... more)
FileSystemProvider	provider()

Methods inherited from class java.nio.file.FileSystem

close, getFileStores, getPathMatcher, getRootDirectories, getSeparator, getUserPrincipalLookupService, isOpen, isReadOnly, newWatchService, supportedFileAttributeViews

Methods inherited from class java.lang.Object

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

Constructor Detail

InMemoryFileSystem

public InMemoryFileSystem()

Method Detail

createInstance

public static InMemoryFileSystem createInstance()

Creates an instance for a test.

Returns:

an in-memory file system

defineFile

public void defineFile(String filePath,
                       String contents)

Defines the contents for an in-memory file. Will convert the string to bytes using the default platform encoding.

Parameters:

filePath - the path to the file

contents - a string to use as the file constants

defineFile

public void defineFile(String filePath,
                       String contents,
                       String charset)

Defines the contents for an in-memory file. Will convert the string to bytes using the specified encoding.

Parameters:

filePath - the path to the file

contents - a string to use as the file constants

charset - the character set to use to translate the string to bytes

defineFile

public void defineFile(String filePath,
                       byte... contents)

Defines the contents for an in-memory file.

Parameters:

filePath - the path to the file

contents - the file contents

getPath

public Path getPath(String first,
                    String... more)

Specified by:

getPath in class FileSystem

provider

public FileSystemProvider provider()

Specified by:

provider in class FileSystem