com.box.sdk

Class FileUploadParams

Object

FileUploadParams

public class FileUploadParams
extends Object

Contains parameters for configuring an upload to Box.

Constructor Summary

Constructors

Constructor and Description
FileUploadParams() Constructs a new FileUploadParams with default parameters.

Method Summary

Modifier and Type	Method and Description
InputStream	getContent() Gets the content that will be uploaded to Box.
Date	getCreated() Gets the content created date that will be given to the uploaded file.
String	getDescription() Gets the file's description set for uploading.
Date	getModified() Gets the content modified date that will be given to the uploaded file.
String	getName() Gets the name that will be given to the uploaded file.
ProgressListener	getProgressListener() Gets the ProgressListener that will be used for monitoring the upload's progress.
String	getSHA1() Gets the file's SHA-1 hash.
long	getSize() Gets the size of the file's content used for monitoring the upload's progress.
UploadFileCallback	getUploadFileCallback()
FileUploadParams	setContent(InputStream content) Sets the content that will be uploaded to Box.
FileUploadParams	setCreated(Date created) Sets the content created date that will be given to the uploaded file.
FileUploadParams	setDescription(String description) Sets the file description during the file upload.
FileUploadParams	setModified(Date modified) Sets the content modified date that will be given to the uploaded file.
FileUploadParams	setName(String name) Sets the name that will be given to the uploaded file.
FileUploadParams	setProgressListener(ProgressListener listener) Sets the ProgressListener that will be used for monitoring the upload's progress.
FileUploadParams	setSHA1(String sha1) Set the SHA-1 hash of the file to ensure it is not corrupted during the upload.
FileUploadParams	setSize(long size) Sets the size of the file content used for monitoring the upload's progress.
FileUploadParams	setUploadFileCallback(UploadFileCallback uploadFileCallback) Sets the content writer callback.

Methods inherited from class Object

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

Constructor Detail

FileUploadParams

public FileUploadParams()

Constructs a new FileUploadParams with default parameters.

Method Detail

getContent

public InputStream getContent()

Gets the content that will be uploaded to Box.

Returns:

an InputStream that reads the content to be uploaded to Box.

setContent

public FileUploadParams setContent(InputStream content)

Sets the content that will be uploaded to Box.

Parameters:

content - an InputStream that reads from the content to be uploaded to Box.

Returns:

this FileUploadParams object for chaining.

getUploadFileCallback

public UploadFileCallback getUploadFileCallback()

Returns:

content writer callback.

setUploadFileCallback

public FileUploadParams setUploadFileCallback(UploadFileCallback uploadFileCallback)

Sets the content writer callback.

Parameters:

uploadFileCallback - callback called when file upload starts.

Returns:

this FileUploadParams object for chaining.

getName

public String getName()

Gets the name that will be given to the uploaded file.

Returns:

the name that will be given to the uploaded file.

setName

public FileUploadParams setName(String name)

Sets the name that will be given to the uploaded file.

Parameters:

name - the name that will be given to the uploaded file.

Returns:

this FileUploadParams object for chaining.

getCreated

public Date getCreated()

Gets the content created date that will be given to the uploaded file.

Returns:

the content created date that will be given to the uploaded file.

setCreated

public FileUploadParams setCreated(Date created)

Sets the content created date that will be given to the uploaded file.

Parameters:

created - the content created date that will be given to the uploaded file.

Returns:

this FileUploadParams object for chaining.

getModified

public Date getModified()

Gets the content modified date that will be given to the uploaded file.

Returns:

the content modified date that will be given to the uploaded file.

setModified

public FileUploadParams setModified(Date modified)

Sets the content modified date that will be given to the uploaded file.

Parameters:

modified - the content modified date that will be given to the uploaded file.

Returns:

this FileUploadParams object for chaining.

getSize

public long getSize()

Gets the size of the file's content used for monitoring the upload's progress. If the size cannot be determined value will be -1.

Returns:

the size of the file's content.

setSize

public FileUploadParams setSize(long size)

Sets the size of the file content used for monitoring the upload's progress. When the content is coming from a dynamic source - other thread reading value set size to -1 to tell SDK that file size cannot be determined. Usefull when encuntering problems with writing different size of bytes than assumed.

Parameters:

size - the size of the file's content.

Returns:

this FileUploadParams object for chaining.

getProgressListener

public ProgressListener getProgressListener()

Gets the ProgressListener that will be used for monitoring the upload's progress.

Returns:

the ProgressListener that will be used for monitoring the upload's progress.

setProgressListener

public FileUploadParams setProgressListener(ProgressListener listener)

Sets the ProgressListener that will be used for monitoring the upload's progress.

Parameters:

listener - the listener that will be used for monitoring the upload's progress.

Returns:

this FileUploadParams object for chaining.

getSHA1

public String getSHA1()

Gets the file's SHA-1 hash.

Returns:

the file hash.

setSHA1

public FileUploadParams setSHA1(String sha1)

Set the SHA-1 hash of the file to ensure it is not corrupted during the upload.

Parameters:

sha1 - the SHA-1 hash of the file.

Returns:

this FileUploadParams for chaining.

getDescription

public String getDescription()

Gets the file's description set for uploading.

Returns:

the file description.

setDescription

public FileUploadParams setDescription(String description)

Sets the file description during the file upload.

Parameters:

description - the description of the file.

Returns:

this FileUploadParams for chaining.