org.apache.lucene.mockfile

Class HandleTrackingFS

java.lang.Object

java.nio.file.spi.FileSystemProvider

org.apache.lucene.mockfile.FilterFileSystemProvider

org.apache.lucene.mockfile.HandleTrackingFS

Direct Known Subclasses:

HandleLimitFS, LeakFS, WindowsFS

public abstract class HandleTrackingFS
extends FilterFileSystemProvider

Base class for tracking file handles.

This class adds tracking to all streams/channels and provides two hooks to handle file management:

• onOpen(Path, Object)
• onClose(Path, Object)

Field Summary

Fields inherited from class org.apache.lucene.mockfile.FilterFileSystemProvider

delegate, fileSystem, scheme

Constructor Summary

Constructors

Constructor and Description
HandleTrackingFS(java.lang.String scheme, java.nio.file.FileSystem delegate) Create a new instance, identified by scheme and passing through operations to delegate.

Method Summary

Modifier and Type	Method and Description
java.nio.channels.AsynchronousFileChannel	newAsynchronousFileChannel(java.nio.file.Path path, java.util.Set<? extends java.nio.file.OpenOption> options, java.util.concurrent.ExecutorService executor, java.nio.file.attribute.FileAttribute<?>... attrs)
java.nio.channels.SeekableByteChannel	newByteChannel(java.nio.file.Path path, java.util.Set<? extends java.nio.file.OpenOption> options, java.nio.file.attribute.FileAttribute<?>... attrs)
java.nio.file.DirectoryStream<java.nio.file.Path>	newDirectoryStream(java.nio.file.Path dir, java.nio.file.DirectoryStream.Filter<? super java.nio.file.Path> filter)
java.nio.channels.FileChannel	newFileChannel(java.nio.file.Path path, java.util.Set<? extends java.nio.file.OpenOption> options, java.nio.file.attribute.FileAttribute<?>... attrs)
java.io.InputStream	newInputStream(java.nio.file.Path path, java.nio.file.OpenOption... options)
java.io.OutputStream	newOutputStream(java.nio.file.Path path, java.nio.file.OpenOption... options)
protected abstract void	onClose(java.nio.file.Path path, java.lang.Object stream) Called when path is closed via stream.
protected abstract void	onOpen(java.nio.file.Path path, java.lang.Object stream) Called when path is opened via stream.

Methods inherited from class org.apache.lucene.mockfile.FilterFileSystemProvider

checkAccess, copy, createDirectory, createLink, createSymbolicLink, delete, deleteIfExists, getFileAttributeView, getFileStore, getFileSystem, getPath, getScheme, isHidden, isSameFile, move, newFileSystem, newFileSystem, onClose, readAttributes, readAttributes, readSymbolicLink, setAttribute, toDelegate, toString

Methods inherited from class java.nio.file.spi.FileSystemProvider

installedProviders

Methods inherited from class java.lang.Object

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

Constructor Detail

HandleTrackingFS

public HandleTrackingFS(java.lang.String scheme,
                        java.nio.file.FileSystem delegate)

Create a new instance, identified by scheme and passing through operations to delegate.

Parameters:

scheme - URI scheme for this provider

delegate - delegate filesystem to wrap.

Method Detail

onOpen

protected abstract void onOpen(java.nio.file.Path path,
                               java.lang.Object stream)
                        throws java.io.IOException

Called when path is opened via stream.

Parameters:

path - Path that was opened

stream - Stream or Channel opened against the path.

Throws:

java.io.IOException - if an I/O error occurs.

onClose

protected abstract void onClose(java.nio.file.Path path,
                                java.lang.Object stream)
                         throws java.io.IOException

Called when path is closed via stream.

Parameters:

path - Path that was closed

stream - Stream or Channel closed against the path.

Throws:

java.io.IOException - if an I/O error occurs.

newInputStream

public java.io.InputStream newInputStream(java.nio.file.Path path,
                                          java.nio.file.OpenOption... options)
                                   throws java.io.IOException

Overrides:

newInputStream in class FilterFileSystemProvider

Throws:

java.io.IOException

newOutputStream

public java.io.OutputStream newOutputStream(java.nio.file.Path path,
                                            java.nio.file.OpenOption... options)
                                     throws java.io.IOException

Overrides:

newOutputStream in class FilterFileSystemProvider

Throws:

java.io.IOException

newFileChannel

public java.nio.channels.FileChannel newFileChannel(java.nio.file.Path path,
                                                    java.util.Set<? extends java.nio.file.OpenOption> options,
                                                    java.nio.file.attribute.FileAttribute<?>... attrs)
                                             throws java.io.IOException

Overrides:

newFileChannel in class FilterFileSystemProvider

Throws:

java.io.IOException

newAsynchronousFileChannel

public java.nio.channels.AsynchronousFileChannel newAsynchronousFileChannel(java.nio.file.Path path,
                                                                            java.util.Set<? extends java.nio.file.OpenOption> options,
                                                                            java.util.concurrent.ExecutorService executor,
                                                                            java.nio.file.attribute.FileAttribute<?>... attrs)
                                                                     throws java.io.IOException

Overrides:

newAsynchronousFileChannel in class FilterFileSystemProvider

Throws:

java.io.IOException

newByteChannel

public java.nio.channels.SeekableByteChannel newByteChannel(java.nio.file.Path path,
                                                            java.util.Set<? extends java.nio.file.OpenOption> options,
                                                            java.nio.file.attribute.FileAttribute<?>... attrs)
                                                     throws java.io.IOException

Overrides:

newByteChannel in class FilterFileSystemProvider

Throws:

java.io.IOException

newDirectoryStream

public java.nio.file.DirectoryStream<java.nio.file.Path> newDirectoryStream(java.nio.file.Path dir,
                                                                            java.nio.file.DirectoryStream.Filter<? super java.nio.file.Path> filter)
                                                                     throws java.io.IOException

Overrides:

newDirectoryStream in class FilterFileSystemProvider

Throws:

java.io.IOException