org.apache.sshd.sftp.client.fs

Class SftpDirectoryStream

java.lang.Object

org.apache.sshd.sftp.client.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>, SftpClientHolder

public class SftpDirectoryStream
extends java.lang.Object
implements SftpClientHolder, 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.nio.file.DirectoryStream.Filter<? super java.nio.file.Path>	filter
private SftpPath	path
protected SftpPathIterator	pathIterator
private SftpClient	sftp

Constructor Summary

Constructors

Constructor and Description
SftpDirectoryStream(SftpPath path)
SftpDirectoryStream(SftpPath path, java.nio.file.DirectoryStream.Filter<? super java.nio.file.Path> filter)

Method Summary

Modifier and Type	Method and Description
void	close()
SftpClient	getClient()
java.nio.file.DirectoryStream.Filter<? super java.nio.file.Path>	getFilter()
SftpPath	getRootPath()
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

pathIterator

protected SftpPathIterator pathIterator

path

private final SftpPath path

filter

private final java.nio.file.DirectoryStream.Filter<? super java.nio.file.Path> filter

sftp

private final SftpClient sftp

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

SftpDirectoryStream

public SftpDirectoryStream(SftpPath path,
                           java.nio.file.DirectoryStream.Filter<? super java.nio.file.Path> filter)
                    throws java.io.IOException

Parameters:

path - The remote SftpPath

filter - An optional filter - ignored if null

Throws:

java.io.IOException - If failed to initialize the directory access handle

Method Detail

getClient

public final SftpClient getClient()

Specified by:

getClient in interface SftpClientHolder

getRootPath

public final SftpPath getRootPath()

Returns:

The root SftpPath for this directory stream

getFilter

public final java.nio.file.DirectoryStream.Filter<? super java.nio.file.Path> getFilter()

Returns:

The original filter - may be null to indicate no filter

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