Apache Mina SSHD 2.15.0 · org.apache.sshd.sftp.client.fs.SftpDirectoryStream

Modifier and Type	Field and Description
private final DirectoryStream.Filter<? super Path>	filter
private final SftpPath	path
protected SftpPathIterator	pathIterator
protected boolean	pathIteratorConsumed
private final SftpClient	sftp

Constructor Summary

Access	Constructor and Description
public	SftpDirectoryStream(SftpPath The remote `SftpPath` path)
public	SftpDirectoryStream(SftpPath The remote `SftpPath` path, DirectoryStream.Filter<? super Path> An optional `filter` - ignored if `null` filter)

Method Summary

Modifier and Type	Method and Description
public void	close() Implements java.io.Closeable.close. Closes this stream and releases any system resources associated with it.
public final SftpClient	getClient() Implements org.apache.sshd.sftp.client.SftpClientHolder.getClient.
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 stream getRootPath()
public Iterator<Path>	iterator() Implements java.nio.file.DirectoryStream.iterator. Returns the iterator associated with this `DirectoryStream`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

filter	back to summary
private final DirectoryStream.Filter<? super Path> filter

path	back to summary
private final SftpPath path

pathIterator	back to summary
protected SftpPathIterator pathIterator

pathIteratorConsumed	back to summary
protected boolean pathIteratorConsumed

sftp	back to summary
private final SftpClient sftp

Constructor Detail

SftpDirectoryStream	back to summary
public SftpDirectoryStream(SftpPath path) throws IOException Parameters path:SftpPath The remote `SftpPath` Exceptions IOException: If failed to initialize the directory access handle

SftpDirectoryStream	back to summary
public SftpDirectoryStream(SftpPath path, DirectoryStream.Filter<? super Path> filter) throws IOException Parameters path:SftpPath The remote `SftpPath` filter:DirectoryStream.Filter<? super Path> An optional `filter` - ignored if `null` Exceptions IOException: If failed to initialize the directory access handle

Method Detail

close back to summary

close	back to summary
public void close() throws IOException Implements java.io.Closeable.close. Doc from java.io.Closeable.close. Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect. As noted in `AutoCloseable#close()`, cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the `Closeable` as closed, prior to throwing the `IOException`. Annotations @Override Exceptions IOException: if an I/O error occurs

public void close() throws IOException

Implements java.io.Closeable.close.

Doc from java.io.Closeable.close.

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

As noted in AutoCloseable#close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs

getClient	back to summary
public final SftpClient getClient() Implements org.apache.sshd.sftp.client.SftpClientHolder.getClient. Annotations @Override

getClient

back to summary

public final SftpClient getClient()

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

Annotations

@Override

getFilter	back to summary
public final DirectoryStream.Filter<? super Path> getFilter() Returns:DirectoryStream.Filter<? super Path> The original filter - may be `null` to indicate no filter

getRootPath	back to summary
public final SftpPath getRootPath() Returns:SftpPath The root `SftpPath` for this directory stream

iterator back to summary

iterator	back to summary
public Iterator<Path> iterator() Implements java.nio.file.DirectoryStream.iterator. Doc from java.nio.file.DirectoryStream.iterator. Returns the iterator associated with this `DirectoryStream`. Returns:Iterator<Path> the iterator associated with this `DirectoryStream` Annotations @Override

public Iterator<Path> iterator()

Implements java.nio.file.DirectoryStream.iterator.

Doc from java.nio.file.DirectoryStream.iterator.

Returns the iterator associated with this DirectoryStream.

Returns:Iterator<Path>

the iterator associated with this DirectoryStream

Annotations

@Override

public Class SftpDirectoryStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail