public final class FileTransfer
extends java.lang.Object
A class for managing a single file transfer. It allows to monitor the progress and status of a file transfer by adding a listener.
Modifier and Type | Class and Description |
---|---|
static class |
FileTransfer.Status
The status of the file transfer.
|
Constructor and Description |
---|
FileTransfer(XmppSession xmppSession,
java.lang.String sessionId,
java.io.InputStream inputStream,
java.io.OutputStream outputStream,
long length) |
Modifier and Type | Method and Description |
---|---|
void |
addFileTransferStatusListener(java.util.function.Consumer<FileTransferStatusEvent> fileTransferStatusListener)
Adds a file transfer status listener, which allows to listen for file transfer status changes.
|
void |
cancel()
Cancels the file transfer.
|
long |
getBytesTransferred()
Gets the transferred bytes.
|
java.lang.Exception |
getException()
Gets the exception if the status is
FileTransfer.Status.FAILED |
double |
getProgress()
Gets the progress of the file transfer.
|
java.lang.String |
getSessionId()
Gets the session id for this file transfer session.
|
FileTransfer.Status |
getStatus()
Gets the status of the file transfer.
|
boolean |
isDone()
Returns true, if the file transfer is done, i.e. neither in progress nor in initial status.
|
void |
removeFileTransferStatusListener(java.util.function.Consumer<FileTransferStatusEvent> fileTransferStatusListener)
Removes a previously added file transfer status listener.
|
java.util.concurrent.Future<?> |
transfer()
Transfers the file in its own thread.
|
public FileTransfer(XmppSession xmppSession, java.lang.String sessionId, java.io.InputStream inputStream, java.io.OutputStream outputStream, long length)
public final void addFileTransferStatusListener(java.util.function.Consumer<FileTransferStatusEvent> fileTransferStatusListener)
Adds a file transfer status listener, which allows to listen for file transfer status changes.
fileTransferStatusListener
- The listener.removeFileTransferStatusListener(Consumer)
public final void removeFileTransferStatusListener(java.util.function.Consumer<FileTransferStatusEvent> fileTransferStatusListener)
Removes a previously added file transfer status listener.
fileTransferStatusListener
- The listener.addFileTransferStatusListener(Consumer)
public final FileTransfer.Status getStatus()
Gets the status of the file transfer.
public final boolean isDone()
Returns true, if the file transfer is done, i.e. neither in progress nor in initial status.
public long getBytesTransferred()
Gets the transferred bytes.
public final double getProgress()
Gets the progress of the file transfer.
public final java.util.concurrent.Future<?> transfer()
Transfers the file in its own thread.
public void cancel()
Cancels the file transfer.
public final java.lang.String getSessionId()
Gets the session id for this file transfer session.
public final java.lang.Exception getException()
Gets the exception if the status is FileTransfer.Status.FAILED
Copyright © 2014–2019 XMPP.rocks. All rights reserved.