Top Description Fields Constructors Methods
org.apache.sshd.common.file.root

public Class RootedDirectoryStream

extends Object
implements DirectoryStream<Path>
Class Inheritance
All Implemented Interfaces
java.nio.file.DirectoryStream, java.lang.Iterable, java.io.Closeable, java.lang.AutoCloseable
Known Direct Subclasses
org.apache.sshd.common.file.root.RootedSecureDirectoryStream
Imports
java.io.IOException, java.nio.file.DirectoryStream, .Path, java.util.Iterator
secure directory stream proxy for a RootedFileSystem
Author
Apache MINA SSHD Project

Field Summary

Modifier and TypeField and Description
protected final DirectoryStream<Path>
delegate

protected final RootedFileSystem
rfs

Constructor Summary

AccessConstructor and Description
public
RootedDirectoryStream(RootedFileSystem rfs, DirectoryStream<Path> delegate)

Method Summary

Modifier and TypeMethod and Description
public void
close()

Implements java.io.Closeable.close.

Closes this stream and releases any system resources associated with it.

public Iterator<Path>
iterator()

Implements java.nio.file.DirectoryStream.iterator.

Returns the iterator associated with this DirectoryStream.

protected Iterator<Path>
root(RootedFileSystem rfs, Iterator<Path> iter)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

delegateback to summary
protected final DirectoryStream<Path> delegate
rfsback to summary
protected final RootedFileSystem rfs

Constructor Detail

RootedDirectoryStreamback to summary
public RootedDirectoryStream(RootedFileSystem rfs, DirectoryStream<Path> delegate)

Method Detail

closeback to summary
public void close() throws IOException

Implements java.io.Closeable.close.

Doc from java.io.Closeable.close.

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

As noted in AutoCloseable#close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs
iteratorback to summary
public Iterator<Path> iterator()

Implements java.nio.file.DirectoryStream.iterator.

Doc from java.nio.file.DirectoryStream.iterator.

Returns the iterator associated with this DirectoryStream.

Returns:Iterator<Path>

the iterator associated with this DirectoryStream

Annotations
@Override
rootback to summary
protected Iterator<Path> root(RootedFileSystem rfs, Iterator<Path> iter)