com.palantir.giraffe.file.base

Class AbstractFilteredDirectoryStream<T>

java.lang.Object

com.palantir.giraffe.file.base.AbstractFilteredDirectoryStream<T>

Type Parameters:

T - the type of element returned by the iterator

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<T>, DirectoryStream<T>

public abstract class AbstractFilteredDirectoryStream<T>
extends Object
implements DirectoryStream<T>

An thread-safe, abstract DirectoryStream that applies a filter to an underlying entry iterator.

Nested Class Summary

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

DirectoryStream.Filter<T>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractFilteredDirectoryStream(DirectoryStream.Filter<? super T> filter)

Method Summary

Modifier and Type	Method and Description
void	close()
protected abstract void	doClose() Performs implementation-specific close actions.
protected abstract Iterator<T>	entryIterator() Creates and returns an iterator over the entries in this directory.
Iterator<T>	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

Constructor Detail

AbstractFilteredDirectoryStream

protected AbstractFilteredDirectoryStream(DirectoryStream.Filter<? super T> filter)

Method Detail

close

public final void close()
                 throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

doClose

protected abstract void doClose()
                         throws IOException

Performs implementation-specific close actions. This method is called at most once.

Throws:

IOException - if an I/O error occurs

iterator

public final Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

Specified by:

iterator in interface DirectoryStream<T>

entryIterator

protected abstract Iterator<T> entryIterator()

Creates and returns an iterator over the entries in this directory. This method is called at most once and only if the stream is open.

The iterator is not required to be thread-safe, but otherwise must follow the read-ahead contract outlined by DirectoryStream.