FileTransfer (Babbler 0.5.1)

java.lang.Object
- rocks.xmpp.extensions.filetransfer.FileTransfer

```
public final class FileTransfer
extends Object
```
A class for managing a single file transfer. It allows to monitor

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FileTransfer.Status

Nested Classes
Modifier and Type	Class and Description
`static class`	`FileTransfer.Status`

Constructor Summary

Constructors
Constructor and Description

FileTransfer(InputStream inputStream, OutputStream outputStream, long length)

Constructors
Constructor and Description
`FileTransfer(InputStream inputStream, OutputStream outputStream, long length)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addFileTransferStatusListener(FileTransferStatusListener fileTransferStatusListener)` Adds a file transfer status listener, which allows to listen for file transfer status changes.
`void`	`cancel()`
`long`	`getBytesTransferred()` Gets the transferred bytes.
`Exception`	`getException()` Gets the exception if the status is `FileTransfer.Status.FAILED`
`double`	`getProgress()` Gets the progress of the file transfer.
`FileTransfer.Status`	`getStatus()` Gets the status of the file transfer.
`boolean`	`isDone()`
`void`	`removeFileTransferStatusListener(FileTransferStatusListener fileTransferStatusListener)` Removes a previously added file transfer status listener.
`void`	`transfer()` Transfers the file in its own thread.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FileTransfer
```
public FileTransfer(InputStream inputStream,
            OutputStream outputStream,
            long length)
```
- Method Detail
  - addFileTransferStatusListener
```
public void addFileTransferStatusListener(FileTransferStatusListener fileTransferStatusListener)
```
    Adds a file transfer status listener, which allows to listen for file transfer status changes.
    
    Parameters:
    fileTransferStatusListener - The listener.
    See Also:
    removeFileTransferStatusListener(FileTransferStatusListener)
  - removeFileTransferStatusListener
```
public void removeFileTransferStatusListener(FileTransferStatusListener fileTransferStatusListener)
```
    Removes a previously added file transfer status listener.
    
    Parameters:
    fileTransferStatusListener - The listener.
    See Also:
    addFileTransferStatusListener(FileTransferStatusListener)
  - getStatus
```
public FileTransfer.Status getStatus()
```
    Gets the status of the file transfer.
    
    Returns:
    The status.
  - isDone
```
public boolean isDone()
```
  - getBytesTransferred
```
public long getBytesTransferred()
```
    Gets the transferred bytes.
    
    Returns:
    The transferred bytes.
  - getProgress
```
public double getProgress()
```
    Gets the progress of the file transfer.
    
    Returns:
    A value between 0 and 1 indicating the progress or -1 if the progress is unknown.
  - transfer
```
public void transfer()
```
    Transfers the file in its own thread.
  - cancel
```
public void cancel()
```
  - getException
```
public Exception getException()
```
    Gets the exception if the status is FileTransfer.Status.FAILED
    
    Returns:
    The exception or null.

Class FileTransfer

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FileTransfer

Method Detail

addFileTransferStatusListener

removeFileTransferStatusListener

getStatus

isDone

getBytesTransferred

getProgress

transfer

cancel

getException