Top Description Fields Constructors Methods
org.apache.sshd.sftp.client.fs

public Class SftpPathIterator

extends Object
implements Iterator<Path>
Class Inheritance
All Implemented Interfaces
java.util.Iterator
Imports
java.io.Closeable, .IOException, java.nio.file.DirectoryIteratorException, .DirectoryStream, .DirectoryStream.Filter, .Path, java.util.Iterator, .NoSuchElementException, .Objects, org.apache.sshd.sftp.client.SftpClient
Implements and Iterator of SftpPath-s returned by a DirectoryStream#iterator() method.
Author
Apache MINA SSHD Project

Field Summary

Modifier and TypeField and Description
protected SftpPath
curEntry

protected boolean
dotdotIgnored

protected boolean
dotIgnored

private DirectoryStream.Filter<? super Path>
filter

protected Iterator<? extends SftpClient.DirEntry>
it

private final SftpPath
path

Constructor Summary

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

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

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

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

Method Summary

Modifier and TypeMethod and Description
public final void
close()

public final DirectoryStream.Filter<? super Path>

Returns:

The original filter - may be null to indicate no filter
getFilter()

public final SftpPath

Returns:

The root SftpPath for this directory iterator
getRootPath()

public boolean
hasNext()

Implements java.util.Iterator.hasNext.

Returns true if the iteration has more elements.

public Path
next()

Implements java.util.Iterator.next.

Returns the next element in the iteration.

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

public void
remove()

Overrides default java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation).

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

curEntryback to summary
protected SftpPath curEntry
dotdotIgnoredback to summary
protected boolean dotdotIgnored
dotIgnoredback to summary
protected boolean dotIgnored
filterback to summary
private DirectoryStream.Filter<? super Path> filter
itback to summary
protected Iterator<? extends SftpClient.DirEntry> it
pathback to summary
private final SftpPath path

Constructor Detail

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

Method Detail

closeback to summary
public final void close() throws IOException
getFilterback to summary
public final DirectoryStream.Filter<? super Path> getFilter()
Returns:DirectoryStream.Filter<? super Path>

The original filter - may be null to indicate no filter

getRootPathback to summary
public final SftpPath getRootPath()
Returns:SftpPath

The root SftpPath for this directory iterator

hasNextback to summary
public boolean hasNext()

Implements java.util.Iterator.hasNext.

Doc from java.util.Iterator.hasNext.

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Returns:boolean

true if the iteration has more elements

Annotations
@Override
nextback to summary
public Path next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Returns:Path

the next element in the iteration

Annotations
@Override
nextEntryback to summary
protected SftpPath nextEntry(SftpPath root, DirectoryStream.Filter<? super Path> selector)
removeback to summary
public void remove()

Overrides default java.util.Iterator.remove.

Doc from java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to next.

The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy.

The behavior of an iterator is unspecified if this method is called after a call to the forEachRemaining method.

Annotations
@Override