Module com.aoapps.io.filesystems

Package com.aoapps.io.filesystems

Class RandomFailFileSystem

java.lang.Object

com.aoapps.io.filesystems.FileSystemWrapper

com.aoapps.io.filesystems.RandomFailFileSystem

All Implemented Interfaces:

FileSystem

public class RandomFailFileSystem
extends FileSystemWrapper

A file system implementation that randomly fails, this is used by test suites to verify correct behavior under expected failure modes.

Author:

AO Industries, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RandomFailFileSystem.FailureProbabilities	Provides the failure probabilities.
static class	RandomFailFileSystem.RandomFailIOException	Thrown when a failure occurs randomly.

Nested classes/interfaces inherited from class com.aoapps.io.filesystems.FileSystemWrapper

FileSystemWrapper.PathIteratorWrapper, FileSystemWrapper.PathWrapper

Field Summary

Fields inherited from class com.aoapps.io.filesystems.FileSystemWrapper

wrappedFileSystem

Constructor Summary

Constructors

Constructor	Description
RandomFailFileSystem(FileSystem wrappedFileSystem)	Uses default probabilities and a default fast pseudo-random number generator for non-cryptographic purposes.
RandomFailFileSystem(FileSystem wrappedFileSystem, RandomFailFileSystem.FailureProbabilities failureProbabilities, Random fastRandom)	Creates a new random-fail filesystem, wrapping the given filesystem.

Method Summary

Modifier and Type	Method	Description
Path	createDirectory(Path path)	Atomically creates a directory (must not have already existed).
Path	createFile(Path path)	Atomically creates an empty file (must not have already existed).
void	delete(Path path)	Deletes the file system object at the given path.
PathIterator	list(Path path)	Random chance of fail on list as well as list iteration.
FileLock	lock(Path path)	Locks a file in exclusive mode.
protected void	randomFail(float probability)
long	size(Path path)	Gets the size of the file system object at the given path.

Methods inherited from class com.aoapps.io.filesystems.FileSystemWrapper

checkSubPath, join, parsePath, unwrapPath, wrapPath, wrapSubPath

Methods inherited from class java.lang.Object

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

Constructor Details

RandomFailFileSystem

public RandomFailFileSystem(FileSystem wrappedFileSystem,
 RandomFailFileSystem.FailureProbabilities failureProbabilities,
 Random fastRandom)

Creates a new random-fail filesystem, wrapping the given filesystem.

Parameters:

fastRandom - A fast pseudo-random number generator for non-cryptographic purposes.

RandomFailFileSystem

public RandomFailFileSystem(FileSystem wrappedFileSystem)

Uses default probabilities and a default fast pseudo-random number generator for non-cryptographic purposes.

Method Details

randomFail

protected void randomFail(float probability)
                   throws RandomFailFileSystem.RandomFailIOException

Throws:

RandomFailFileSystem.RandomFailIOException

list

public PathIterator list(Path path)
                  throws RandomFailFileSystem.RandomFailIOException,
IOException

Random chance of fail on list as well as list iteration.

Specified by:

list in interface FileSystem

Overrides:

list in class FileSystemWrapper

Parameters:

path - Must be from this file system.

Returns:

a read-only iterator of children

Throws:

IOException - if an underlying I/O error occurs.

RandomFailFileSystem.RandomFailIOException

delete

public void delete(Path path)
            throws IOException

Description copied from interface: FileSystem

Deletes the file system object at the given path.

Specified by:

delete in interface FileSystem

Overrides:

delete in class FileSystemWrapper

Parameters:

path - Must be from this file system.

Throws:

IOException - if an underlying I/O error occurs.

size

public long size(Path path)
          throws IOException

Description copied from interface: FileSystem

Gets the size of the file system object at the given path.

Specified by:

size in interface FileSystem

Overrides:

size in class FileSystemWrapper

Parameters:

path - Must be from this file system.

Throws:

IOException - if an underlying I/O error occurs.

createFile

public Path createFile(Path path)
                throws IOException

Description copied from interface: FileSystem

Atomically creates an empty file (must not have already existed).

Specified by:

createFile in interface FileSystem

Overrides:

createFile in class FileSystemWrapper

Returns:

returns the path

Throws:

IOException - if an underlying I/O error occurs.

createDirectory

public Path createDirectory(Path path)
                     throws IOException

Description copied from interface: FileSystem

Atomically creates a directory (must not have already existed).

Specified by:

createDirectory in interface FileSystem

Overrides:

createDirectory in class FileSystemWrapper

Returns:

returns the path

Throws:

IOException - if an underlying I/O error occurs.

lock

public FileLock lock(Path path)
              throws IOException

Description copied from interface: FileSystem

Locks a file in exclusive mode. File range and shared locks not currently supported. The lock must be closed to unlock, usually in a try/finally or try-with-resources block. The locks are not reentrant, attempting to obtain the lock from the same thread will result in deadlock.

Specified by:

lock in interface FileSystem

Overrides:

lock in class FileSystemWrapper

Throws:

IOException - if an underlying I/O error occurs.

See Also:

• FileLock.close()