Apache Mina SSHD 2.15.0 · org.apache.sshd.sftp.server.DirectoryHandle

Modifier and Type	Field and Description
private boolean	done
private DirectoryStream<Path>	ds
private Iterator<Path>	fileList
private boolean	sendDot
private boolean	sendDotDot

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

Method Summary

Modifier and Type	Method and Description
public void	close() Overrides org.apache.sshd.sftp.server.Handle.close. Implements java.nio.channels.Channel.close. Closes this channel.
public boolean	hasNext() Implements java.util.Iterator.hasNext. Returns `true` if the iteration has more elements.
public boolean	isDone()
public boolean	isSendDot()
public boolean	isSendDotDot()
public void	markDone()
public void	markDotDotSent()
public void	markDotSent()
public Path	next() Implements java.util.Iterator.next. Returns the next element in the iteration.
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 org.apache.sshd.sftp.server.Handle:: attributeKeys clearAttributes computeAttributeIfAbsent getAttribute getAttributesCount getFile getFileHandle getSubsystem isOpen removeAttribute safe setAttribute signalHandleOpen signalHandleOpening toString

done	back to summary
private boolean done

ds	back to summary
private DirectoryStream<Path> ds

fileList	back to summary
private Iterator<Path> fileList

sendDot	back to summary
private boolean sendDot

sendDotDot	back to summary
private boolean sendDotDot

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

Method Detail

close back to summary

close	back to summary
public void close() throws IOException Overrides org.apache.sshd.sftp.server.Handle.close. Implements java.nio.channels.Channel.close. Doc from java.nio.channels.Channel.close. Closes this channel. After a channel is closed, any further attempt to invoke I/O operations upon it will cause a `ClosedChannelException` to be thrown. If this channel is already closed then invoking this method has no effect. This method may be invoked at any time. If some other thread has already invoked it, however, then another invocation will block until the first invocation is complete, after which it will return without effect. Annotations @Override Exceptions IOException: If an I/O error occurs

public void close() throws IOException

Overrides org.apache.sshd.sftp.server.Handle.close.

Implements java.nio.channels.Channel.close.

Doc from java.nio.channels.Channel.close.

Closes this channel.

After a channel is closed, any further attempt to invoke I/O operations upon it will cause a ClosedChannelException to be thrown.

If this channel is already closed then invoking this method has no effect.

This method may be invoked at any time. If some other thread has already invoked it, however, then another invocation will block until the first invocation is complete, after which it will return without effect.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

hasNext back to summary

hasNext	back 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

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

isDone	back to summary
public boolean isDone()

isSendDot	back to summary
public boolean isSendDot()

isSendDotDot	back to summary
public boolean isSendDotDot()

markDone	back to summary
public void markDone()

markDotDotSent	back to summary
public void markDotDotSent()

markDotSent	back to summary
public void markDotSent()

next	back 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

back 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

remove back to summary

remove	back 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

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

public Class DirectoryHandle

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail