Package org.apache.sshd.sftp.client.fs

Class SftpPathIterator

java.lang.Object

org.apache.sshd.sftp.client.fs.SftpPathIterator

All Implemented Interfaces:

Iterator<Path>

public class SftpPathIterator
extends Object
implements Iterator<Path>

Implements and Iterator of SftpPath-s returned by a DirectoryStream.iterator() method.

Author:

Apache MINA SSHD Project

Field Summary

Fields

Modifier and Type	Field	Description
protected SftpPath	curEntry
protected boolean	dotdotIgnored
protected boolean	dotIgnored
protected Iterator<? extends SftpClient.DirEntry>	it

Constructor Summary

Constructors

Constructor	Description
SftpPathIterator(SftpPath path, Iterable<? extends SftpClient.DirEntry> iter)
SftpPathIterator(SftpPath path, Iterable<? extends SftpClient.DirEntry> iter, DirectoryStream.Filter<? super Path> filter)
SftpPathIterator(SftpPath path, Iterator<? extends SftpClient.DirEntry> iter)
SftpPathIterator(SftpPath path, Iterator<? extends SftpClient.DirEntry> iter, DirectoryStream.Filter<? super Path> filter)

Method Summary

Modifier and Type	Method	Description
void	close()
DirectoryStream.Filter<? super Path>	getFilter()
SftpPath	getRootPath()
boolean	hasNext()
Path	next()
protected SftpPath	nextEntry(SftpPath root, DirectoryStream.Filter<? super Path> selector)
void	remove()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Iterator

forEachRemaining

Field Detail

it

protected Iterator<? extends SftpClient.DirEntry> it

dotIgnored

protected boolean dotIgnored

dotdotIgnored

protected boolean dotdotIgnored

curEntry

protected SftpPath curEntry

Constructor Detail

SftpPathIterator

public SftpPathIterator(SftpPath path,
                        Iterable<? extends SftpClient.DirEntry> iter)

SftpPathIterator

public SftpPathIterator(SftpPath path,
                        Iterable<? extends SftpClient.DirEntry> iter,
                        DirectoryStream.Filter<? super Path> filter)

SftpPathIterator

public SftpPathIterator(SftpPath path,
                        Iterator<? extends SftpClient.DirEntry> iter)

SftpPathIterator

public SftpPathIterator(SftpPath path,
                        Iterator<? extends SftpClient.DirEntry> iter,
                        DirectoryStream.Filter<? super Path> filter)

Method Detail

getRootPath

public final SftpPath getRootPath()

Returns:

The root SftpPath for this directory iterator

getFilter

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

Returns:

The original filter - may be null to indicate no filter

close

public final void close()
                 throws IOException

Throws:

IOException

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<Path>

next

public Path next()

Specified by:

next in interface Iterator<Path>

nextEntry

protected SftpPath nextEntry(SftpPath root,
                             DirectoryStream.Filter<? super Path> selector)

remove

public void remove()

Specified by:

remove in interface Iterator<Path>