de.tuberlin.onedrivesdk.uploadFile

Interface OneUploadFile

All Superinterfaces:

java.util.concurrent.Callable<OneFile>

public interface OneUploadFile
extends java.util.concurrent.Callable<OneFile>

This Interface provides all Methods to (resumable) upload a File

Method Summary

Modifier and Type	Method and Description
OneUploadFile	cancelUpload() Will cancel the upload completely.
long	fileSize() Gets the size of the file that is uploaded (convenience method for simple completion Percent calculation)
java.io.File	getUploadFile() Gets the file handle of the file that is being uploaded
OneUploadFile	pauseUpload() Will pause the upload.
OneUploadFile	resumeUpload() Will resume the upload if it got paused/interrupted.
OneFile	startUpload() Starts the upload, needs to be called to start the upload.
long	uploadStatus() Gets something like an enum indication that the upload is either finished,running,paused,canceled...

Methods inherited from interface java.util.concurrent.Callable

call

Method Detail

fileSize

long fileSize()

Gets the size of the file that is uploaded (convenience method for simple completion Percent calculation)

Returns:

size of the file

uploadStatus

long uploadStatus()
           throws java.io.IOException,
                  OneDriveException

Gets something like an enum indication that the upload is either finished,running,paused,canceled...

Returns:

upload status

Throws:

java.io.IOException

OneDriveException

startUpload

OneFile startUpload()
             throws java.io.IOException,
                    OneDriveException

Starts the upload, needs to be called to start the upload. Will throw exception when called while the download has already been started Blocks until either upload is finished or interrupted.

Returns:

the OneFile handle for the finished file

Throws:

java.io.IOException

OneDriveException

pauseUpload

OneUploadFile pauseUpload()

Will pause the upload. Does nothing when called if the download is already paused

Returns:

this.OneUploadFile

resumeUpload

OneUploadFile resumeUpload()

Will resume the upload if it got paused/interrupted. Calling this method on an already running upload will do nothing

Returns:

this.OneUploadFile

cancelUpload

OneUploadFile cancelUpload()
                    throws java.io.IOException,
                           OneDriveAuthenticationException

Will cancel the upload completely. Calling this more than once will do nothing Canceled uploads can't be resumed Will block until file Upload is finished

Returns:

the OneFile handle of the finished File or null on interruption

Throws:

java.io.IOException

OneDriveAuthenticationException

getUploadFile

java.io.File getUploadFile()

Gets the file handle of the file that is being uploaded

Returns:

the file handle of the File that is uploaded