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

public Class SftpIterableDirEntry

extends Object
implements SftpClientHolder, Iterable<SftpClient.DirEntry>
Class Inheritance
All Implemented Interfaces
java.lang.Iterable, org.apache.sshd.sftp.client.SftpClientHolder
Imports
java.io.IOException, .UncheckedIOException, java.util.Objects, org.apache.sshd.common.util.ValidateUtils, org.apache.sshd.sftp.client.SftpClient, .SftpClient.DirEntry, .SftpClientHolder

Provides an Iterable implementation of the DirEntry-ies for a remote directory
Author
Apache MINA SSHD Project

Field Summary

Modifier and TypeField and Description
private final SftpClient
private final String

Constructor Summary

AccessConstructor and Description
public
SftpIterableDirEntry(SftpClient
The SftpClient instance to use for the iteration
client
,
String
The remote directory path
path
)

Method Summary

Modifier and TypeMethod and Description
public final SftpClient
public final String

Returns:

Remote directory path
getPath
()

The remotely accessed directory path

public SftpDirEntryIterator
iterator()

Implements java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

clientback to summary
private final SftpClient client
pathback to summary
private final String path

Constructor Detail

SftpIterableDirEntryback to summary
public SftpIterableDirEntry(SftpClient client, String path)
Parameters
client:SftpClient

The SftpClient instance to use for the iteration

path:String

The remote directory path

Method Detail

getClientback to summary
public final SftpClient getClient()

Implements org.apache.sshd.sftp.client.SftpClientHolder.getClient.

Annotations
@Override
getPathback to summary
public final String getPath()

The remotely accessed directory path

Returns:String

Remote directory path

iteratorback to summary
public SftpDirEntryIterator iterator()

Implements java.lang.Iterable.iterator.

Doc from java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

Returns:SftpDirEntryIterator

an Iterator.

Annotations
@Override