org.apache.sshd.client.subsystem.sftp.fs

Class SftpDirectoryStream

java.lang.Object

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

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 SftpDirectoryStream
extends java.lang.Object
implements java.nio.file.DirectoryStream<java.nio.file.Path>

Implements a remote DirectoryStream

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
private java.lang.Iterable<SftpClient.DirEntry>	iter
private SftpPath	p
private SftpClient	sftp

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
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

sftp

private final SftpClient sftp

iter

private final java.lang.Iterable<SftpClient.DirEntry> iter

p

private final SftpPath p

Constructor Detail

SftpDirectoryStream

public SftpDirectoryStream(SftpPath path)
                    throws java.io.IOException

Parameters:

path - The remote SftpPath

Throws:

java.io.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 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>

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