org.apache.sshd.client.subsystem.sftp

Class SftpDirectoryStream

java.lang.Object

org.apache.sshd.client.subsystem.sftp.SftpDirectoryStream

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<Path>, DirectoryStream<Path>

public class SftpDirectoryStream
extends Object
implements DirectoryStream<Path>

Implements a remote DirectoryStream

Author:

Apache MINA SSHD Project

Nested Class Summary

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

DirectoryStream.Filter<T>

Constructor Summary

Constructors

Constructor and Description
SftpDirectoryStream(SftpPath path)

Method Summary

Modifier and Type	Method and Description
void	close()
SftpClient	getClient() Client instance used to access the remote directory
Iterator<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

Constructor Detail

SftpDirectoryStream

public SftpDirectoryStream(SftpPath path)
                    throws IOException

Parameters:

path - The remote SftpPath

Throws:

IOException - If failed to initialize the directory access handle

Method Detail

getClient

public final SftpClient getClient()

Client instance used to access the remote directory

Returns:

The SftpClient instance used to access the remote directory

iterator

public Iterator<Path> iterator()

Specified by:

iterator in interface Iterable<Path>

Specified by:

iterator in interface DirectoryStream<Path>

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException