Module com.aoapps.io.filesystems

Package com.aoapps.io.filesystems

Class FileSystemWrapper

java.lang.Object

com.aoapps.io.filesystems.FileSystemWrapper

All Implemented Interfaces:

FileSystem

Direct Known Subclasses:

RandomFailFileSystem, ReadOnlyFileSystem

public abstract class FileSystemWrapper
extends Object
implements FileSystem

A file system that wraps another to intercept and otherwise modify interactions.

Author:

AO Industries, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	FileSystemWrapper.PathIteratorWrapper	Wraps PathIterator, wrapping each result in FileSystemWrapper.PathIteratorWrapper.next().
protected static class	FileSystemWrapper.PathWrapper	Wraps a Path.

Field Summary

Fields

Modifier and Type	Field	Description
protected final FileSystem	wrappedFileSystem

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FileSystemWrapper(FileSystem wrappedFileSystem)

Method Summary

Modifier and Type	Method	Description
void	checkSubPath(Path parent, String name)	Checks that a given path name is acceptable to this file system.
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.
Path	join(String[] names)	Joins the array of names to a path object.
PathIterator	list(Path path)	Lists the children of the given path in no specific order.
FileLock	lock(Path path)	Locks a file in exclusive mode.
Path	parsePath(String value)	Parses a string representation of a path.
long	size(Path path)	Gets the size of the file system object at the given path.
protected Path	unwrapPath(Path path)	Unwraps a path.
protected FileSystemWrapper.PathWrapper	wrapPath(Path path)	Wraps a path.
protected FileSystemWrapper.PathWrapper	wrapSubPath(FileSystemWrapper.PathWrapper parent, Path subPath)	Wraps a new sub path.

Methods inherited from class java.lang.Object

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

Field Details

wrappedFileSystem

protected final FileSystem wrappedFileSystem

Constructor Details

FileSystemWrapper

protected FileSystemWrapper(FileSystem wrappedFileSystem)

Method Details

wrapSubPath

protected FileSystemWrapper.PathWrapper wrapSubPath(FileSystemWrapper.PathWrapper parent,
 Path subPath)

Wraps a new sub path.

wrapPath

protected FileSystemWrapper.PathWrapper wrapPath(Path path)

Wraps a path.

unwrapPath

protected Path unwrapPath(Path path)

Unwraps a path.

checkSubPath

public void checkSubPath(Path parent,
 String name)
                  throws InvalidPathException

Description copied from interface: FileSystem

Checks that a given path name is acceptable to this file system. Regular path rules are already checked, this is for additional file system specific constraints. The root path is never passed here.

Specified by:

checkSubPath in interface FileSystem

Parameters:

name - The path to check, must be from this file system.

Throws:

InvalidPathException - If the path is not acceptable

join

public Path join(String[] names)
          throws InvalidPathException

Description copied from interface: FileSystem

Joins the array of names to a path object. Stops at the end of the array or the first null element.

Specified by:

join in interface FileSystem

Throws:

InvalidPathException

See Also:

• for the inverse operation
• for the inverse operation

parsePath

public Path parsePath(String value)
               throws InvalidPathException

Description copied from interface: FileSystem

Parses a string representation of a path.

Specified by:

parsePath in interface FileSystem

Throws:

InvalidPathException

See Also:

• for the inverse operation
• for the inverse operation

list

public PathIterator list(Path path)
                  throws IOException

Description copied from interface: FileSystem

Lists the children of the given path in no specific order. It is possible that paths may be returned that no longer exist. It is also possible that new file system objects created after the beginning of iteration are not returned.

Specified by:

list in interface FileSystem

Parameters:

path - Must be from this file system.

Returns:

a read-only iterator of children

Throws:

IOException - if an underlying I/O error occurs.

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

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

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

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

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

Throws:

IOException - if an underlying I/O error occurs.

See Also:

• FileLock.close()