com.box.androidsdk.content.models

Class BoxDownload

java.lang.Object

com.box.androidsdk.content.models.BoxObject

com.box.androidsdk.content.models.BoxJsonObject

com.box.androidsdk.content.models.BoxDownload

All Implemented Interfaces:

java.io.Serializable

public class BoxDownload
extends BoxJsonObject

Class that represents a download response from the Box API.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.box.androidsdk.content.models.BoxJsonObject

BoxJsonObject.BoxJsonObjectCreator<E extends BoxJsonObject>

Constructor Summary

Constructors

Constructor and Description
BoxDownload(java.lang.String contentDisposition, long contentLength, java.lang.String contentType, java.lang.String contentRange, java.lang.String date, java.lang.String expirationDate) Creates a BoxDownload object.

Method Summary

Modifier and Type	Method and Description
java.lang.Long	getContentLength() Gets the length of the content.
java.lang.String	getContentType() Gets the content type.
java.util.Date	getDate()
java.lang.Long	getEndRange()
java.util.Date	getExpiration()
java.lang.String	getFileName() Gets the name of the file downloaded.
java.io.File	getOutputFile() Gets the output file.
java.lang.Long	getStartRange()
java.lang.Long	getTotalRange()
protected void	setContentRange(java.lang.String contentRange)
protected void	setFileName(java.lang.String contentDisposition)

Methods inherited from class com.box.androidsdk.content.models.BoxJsonObject

addInJsonArray, addInJsonArray, createFromJson, createFromJson, equals, getBoxJsonObjectCreator, getPropertiesKeySet, getPropertyAsBoolean, getPropertyAsDate, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsJsonArray, getPropertyAsJsonObject, getPropertyAsJsonObjectArray, getPropertyAsLong, getPropertyAsString, getPropertyAsStringArray, getPropertyAsStringHashSet, getPropertyValue, hashCode, parseJSONMember, remove, set, set, set, set, set, set, set, set, set, toJson, toJsonObject

Methods inherited from class java.lang.Object

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

Constructor Detail

BoxDownload

public BoxDownload(java.lang.String contentDisposition,
                   long contentLength,
                   java.lang.String contentType,
                   java.lang.String contentRange,
                   java.lang.String date,
                   java.lang.String expirationDate)

Creates a BoxDownload object.

Parameters:

contentDisposition - the suggested default file name for the file (generally matches the current file name on Box).

contentLength - the size of the file in bytes.

contentType - suggested mime type of the file.

contentRange - the range covered in this download in the format "bytes 0-1/5".

date - date of the response.

expirationDate - the estimated date this download is applicable for.

Method Detail

setFileName

protected void setFileName(java.lang.String contentDisposition)

setContentRange

protected void setContentRange(java.lang.String contentRange)

getFileName

public java.lang.String getFileName()

Gets the name of the file downloaded.

Returns:

name of the file downloaded

getOutputFile

public java.io.File getOutputFile()

Gets the output file.

Returns:

the output file for the download.

getContentLength

public java.lang.Long getContentLength()

Gets the length of the content.

Returns:

the length of the content in bytes.

getContentType

public java.lang.String getContentType()

Gets the content type.

Returns:

the HTTP content type.

getStartRange

public java.lang.Long getStartRange()

Returns:

the starting byte of the range for the download if applicable.

getEndRange

public java.lang.Long getEndRange()

Returns:

the ending byte of the range for the download if applicable.

getTotalRange

public java.lang.Long getTotalRange()

Returns:

the total number of bytes covered between the started and end range.

getDate

public java.util.Date getDate()

Returns:

the date this box download was generated.

getExpiration

public java.util.Date getExpiration()

Returns:

the estimated date this download is applicable for.