com.box.androidsdk.content.models

Class BoxFile

java.lang.Object

com.box.androidsdk.content.models.BoxObject

com.box.androidsdk.content.models.BoxJsonObject

com.box.androidsdk.content.models.BoxEntity

com.box.androidsdk.content.models.BoxItem

com.box.androidsdk.content.models.BoxFile

All Implemented Interfaces:

java.io.Serializable

public class BoxFile
extends BoxItem

Class that represents a file on Box.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BoxFile.Permission Enumerates the possible permissions that a user can have on a file.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	ALL_FIELDS
static java.lang.String	FIELD_COMMENT_COUNT
static java.lang.String	FIELD_CONTENT_CREATED_AT
static java.lang.String	FIELD_CONTENT_MODIFIED_AT
static java.lang.String	FIELD_EXTENSION
static java.lang.String	FIELD_FILE_VERSION
static java.lang.String	FIELD_IS_PACKAGE
static java.lang.String	FIELD_SHA1
static java.lang.String	FIELD_SIZE
static java.lang.String	FIELD_VERSION_NUMBER
static java.lang.String	TYPE

Fields inherited from class com.box.androidsdk.content.models.BoxItem

FIELD_ALLOWED_SHARED_LINK_ACCESS_LEVELS, FIELD_CREATED_AT, FIELD_CREATED_BY, FIELD_DESCRIPTION, FIELD_ETAG, FIELD_ITEM_STATUS, FIELD_MODIFIED_AT, FIELD_MODIFIED_BY, FIELD_NAME, FIELD_OWNED_BY, FIELD_PARENT, FIELD_PATH_COLLECTION, FIELD_PERMISSIONS, FIELD_PURGED_AT, FIELD_SEQUENCE_ID, FIELD_SHARED_LINK, FIELD_SYNCED, FIELD_TAGS, FIELD_TRASHED_AT

Fields inherited from class com.box.androidsdk.content.models.BoxEntity

FIELD_ID, FIELD_ITEM_ID, FIELD_ITEM_TYPE, FIELD_TYPE

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

mProperties

Constructor Summary

Constructors

Constructor and Description
BoxFile() Constructs an empty BoxFile object.
BoxFile(java.util.Map<java.lang.String,java.lang.Object> map) Constructs a BoxFile with the provided map values

Method Summary

Modifier and Type	Method and Description
static BoxFile	createFromId(java.lang.String fileId) A convenience method to create an empty file with just the id and type fields set.
java.lang.Long	getCommentCount() Gets the number of comments on the item.
java.util.Date	getContentCreatedAt() Gets the time that the item was created according to the uploader.
java.util.Date	getContentModifiedAt() Gets the time that the item was last modified according to the uploader.
java.lang.String	getExtension() Gets the extension suffix of the file, excluding the dot.
BoxFileVersion	getFileVersion() Gets the version information of the given file.
java.lang.Boolean	getIsPackage() Gets whether or not the file is an OSX package.
java.util.EnumSet<BoxFile.Permission>	getPermissions() Gets the permissions that the current user has on the file.
java.lang.String	getSha1() Gets the SHA1 hash of the file.
java.lang.Long	getSize() Gets the size of the item in bytes.
java.lang.String	getVersionNumber() Gets the current version number of the file.
protected void	parseJSONMember(com.eclipsesource.json.JsonObject.Member member) Invoked with a JSON member whenever this object is updated or created from a JSON object.

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

createBoxItemFromJson, createBoxItemFromJson, getAllowedSharedLinkAccessLevels, getCreatedAt, getCreatedBy, getDescription, getEtag, getIsSynced, getItemStatus, getModifiedAt, getModifiedBy, getName, getOwnedBy, getParent, getPathCollection, getPurgedAt, getSequenceID, getSharedLink, getTrashedAt, parseJsonObject

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

createEntityFromJson, createEntityFromJson, getId, getType

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

createFromJson, createFromJson, getPropertiesAsHashMap, parseNullJsonMember, toJson, toJsonObject

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

FIELD_SHA1

public static final java.lang.String FIELD_SHA1

See Also:

Constant Field Values

FIELD_VERSION_NUMBER

public static final java.lang.String FIELD_VERSION_NUMBER

See Also:

Constant Field Values

FIELD_EXTENSION

public static final java.lang.String FIELD_EXTENSION

See Also:

Constant Field Values

FIELD_IS_PACKAGE

public static final java.lang.String FIELD_IS_PACKAGE

See Also:

Constant Field Values

FIELD_COMMENT_COUNT

public static final java.lang.String FIELD_COMMENT_COUNT

See Also:

Constant Field Values

FIELD_SIZE

public static final java.lang.String FIELD_SIZE

See Also:

Constant Field Values

FIELD_CONTENT_CREATED_AT

public static final java.lang.String FIELD_CONTENT_CREATED_AT

See Also:

Constant Field Values

FIELD_CONTENT_MODIFIED_AT

public static final java.lang.String FIELD_CONTENT_MODIFIED_AT

See Also:

Constant Field Values

FIELD_FILE_VERSION

public static final java.lang.String FIELD_FILE_VERSION

See Also:

Constant Field Values

ALL_FIELDS

public static final java.lang.String[] ALL_FIELDS

Constructor Detail

BoxFile

public BoxFile()

Constructs an empty BoxFile object.

BoxFile

public BoxFile(java.util.Map<java.lang.String,java.lang.Object> map)

Constructs a BoxFile with the provided map values

Parameters:

map - - map of keys and values of the object

Method Detail

createFromId

public static BoxFile createFromId(java.lang.String fileId)

A convenience method to create an empty file with just the id and type fields set. This allows the ability to interact with the content sdk in a more descriptive and type safe manner

Parameters:

fileId - the id of folder to create

Returns:

an empty BoxFile object that only contains id and type information

getFileVersion

public BoxFileVersion getFileVersion()

Gets the version information of the given file.

Returns:

version info of the current file.

getSha1

public java.lang.String getSha1()

Gets the SHA1 hash of the file.

Returns:

the SHA1 hash of the file.

getVersionNumber

public java.lang.String getVersionNumber()

Gets the current version number of the file.

Returns:

the current version number of the file.

getPermissions

public java.util.EnumSet<BoxFile.Permission> getPermissions()

Gets the permissions that the current user has on the file.

Returns:

the permissions that the current user has on the file.

getExtension

public java.lang.String getExtension()

Gets the extension suffix of the file, excluding the dot.

Returns:

the extension of the file.

getIsPackage

public java.lang.Boolean getIsPackage()

Gets whether or not the file is an OSX package.

Returns:

true if the file is an OSX package; otherwise false.

getContentCreatedAt

public java.util.Date getContentCreatedAt()

Description copied from class: BoxItem

Gets the time that the item was created according to the uploader.

Overrides:

getContentCreatedAt in class BoxItem

Returns:

the time that the item was created according to the uploader.

getSize

public java.lang.Long getSize()

Description copied from class: BoxItem

Gets the size of the item in bytes.

Overrides:

getSize in class BoxItem

Returns:

the size of the item in bytes.

getContentModifiedAt

public java.util.Date getContentModifiedAt()

Description copied from class: BoxItem

Gets the time that the item was last modified according to the uploader.

Overrides:

getContentModifiedAt in class BoxItem

Returns:

the time that the item was last modified according to the uploader.

getCommentCount

public java.lang.Long getCommentCount()

Description copied from class: BoxItem

Gets the number of comments on the item.

Overrides:

getCommentCount in class BoxItem

Returns:

the number of comments on the item.

parseJSONMember

protected void parseJSONMember(com.eclipsesource.json.JsonObject.Member member)

Description copied from class: BoxJsonObject

Invoked with a JSON member whenever this object is updated or created from a JSON object.

Subclasses should override this method in order to parse any JSON members it knows about. This method is a no-op by default.

Overrides:

parseJSONMember in class BoxItem

Parameters:

member - the JSON member to be parsed.