org.apache.lucene.mockfile

Class FilterDirectoryStream

java.lang.Object

org.apache.lucene.mockfile.FilterDirectoryStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.lang.Iterable<java.nio.file.Path>, java.nio.file.DirectoryStream<java.nio.file.Path>

public class FilterDirectoryStream
extends java.lang.Object
implements java.nio.file.DirectoryStream<java.nio.file.Path>

A FilterDirectoryStream contains another DirectoryStream, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality.

Nested Class Summary

Nested classes/interfaces inherited from interface java.nio.file.DirectoryStream

java.nio.file.DirectoryStream.Filter<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected java.nio.file.DirectoryStream<java.nio.file.Path>	delegate The underlying DirectoryStream instance.
protected java.nio.file.FileSystem	fileSystem The underlying FileSystem instance.

Constructor Summary

Constructors

Constructor and Description
FilterDirectoryStream(java.nio.file.DirectoryStream<java.nio.file.Path> delegate, java.nio.file.FileSystem fileSystem) Construct a FilterDirectoryStream based on the specified base stream.

Method Summary

Modifier and Type	Method and Description
void	close()
java.util.Iterator<java.nio.file.Path>	iterator()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

delegate

protected final java.nio.file.DirectoryStream<java.nio.file.Path> delegate

The underlying DirectoryStream instance.

fileSystem

protected final java.nio.file.FileSystem fileSystem

The underlying FileSystem instance.

Constructor Detail

FilterDirectoryStream

public FilterDirectoryStream(java.nio.file.DirectoryStream<java.nio.file.Path> delegate,
                             java.nio.file.FileSystem fileSystem)

Construct a FilterDirectoryStream based on the specified base stream.

Note that base stream is closed if this stream is closed.

Parameters:

delegate - specified base stream.

Method Detail

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

iterator

public java.util.Iterator<java.nio.file.Path> iterator()

Specified by:

iterator in interface java.lang.Iterable<java.nio.file.Path>

Specified by:

iterator in interface java.nio.file.DirectoryStream<java.nio.file.Path>