Package org.apache.sshd.sftp.server

Class DirectoryHandle

java.lang.Object

org.apache.sshd.sftp.server.Handle

org.apache.sshd.sftp.server.DirectoryHandle

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, Iterator<Path>, AttributeRepository, AttributeStore

public class DirectoryHandle
extends Handle
implements Iterator<Path>

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.sshd.common.AttributeRepository

AttributeRepository.AttributeKey<T extends Object>

Constructor Summary

Constructors

Constructor	Description
DirectoryHandle(SftpSubsystem subsystem, Path dir, String handle)

Method Summary

Modifier and Type	Method	Description
void	close()
boolean	hasNext()
boolean	isDone()
boolean	isSendDot()
boolean	isSendDotDot()
void	markDone()
void	markDotDotSent()
void	markDotSent()
Path	next()
void	remove()

Methods inherited from class org.apache.sshd.sftp.server.Handle

attributeKeys, clearAttributes, computeAttributeIfAbsent, getAttribute, getAttributesCount, getFile, getFileHandle, getSubsystem, isOpen, removeAttribute, safe, setAttribute, signalHandleOpen, signalHandleOpening, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.sshd.common.AttributeRepository

resolveAttribute

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Details

DirectoryHandle

public DirectoryHandle(SftpSubsystem subsystem,
 Path dir,
 String handle)
                throws IOException

Throws:

IOException

Method Details

isDone

public boolean isDone()

markDone

public void markDone()

isSendDot

public boolean isSendDot()

markDotSent

public void markDotSent()

isSendDotDot

public boolean isSendDotDot()

markDotDotSent

public void markDotDotSent()

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<Path>

next

public Path next()

Specified by:

next in interface Iterator<Path>

remove

public void remove()

Specified by:

remove in interface Iterator<Path>

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Specified by:

close in interface Closeable

Overrides:

close in class Handle

Throws:

IOException