com.box.boxjavalibv2.dao

Class BoxFile

java.lang.Object

com.box.boxjavalibv2.dao.BoxBase

com.box.boxjavalibv2.dao.BoxObject

com.box.boxjavalibv2.dao.BoxTypedObject

com.box.boxjavalibv2.dao.BoxItem

com.box.boxjavalibv2.dao.BoxFile

All Implemented Interfaces:

IBoxParcelable

public class BoxFile
extends BoxItem

Box File object

Field Summary

Fields

Modifier and Type	Field and Description
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_LOCK
static java.lang.String	FIELD_PURGED_AT
static java.lang.String	FIELD_SHA1
static java.lang.String	FIELD_TRASHED_AT
static java.lang.String	FIELD_VERSION_NUMBER

Fields inherited from class com.box.boxjavalibv2.dao.BoxItem

FIELD_ALLOWED_SHARED_LINK_ACCESS_LEVELS, FIELD_COLLECTIONS, FIELD_CREATED_BY, FIELD_DESCRIPTION, FIELD_ETAG, FIELD_ITEM_STATUS, FIELD_MODIFIED_BY, FIELD_NAME, FIELD_OWNED_BY, FIELD_PARENT, FIELD_PATH_COLLECTION, FIELD_PERMISSIONS, FIELD_SEQUENCE_ID, FIELD_SHARED_LINK, FIELD_SIZE, FIELD_TAGS

Fields inherited from class com.box.boxjavalibv2.dao.BoxTypedObject

FIELD_CREATED_AT, FIELD_ID, FIELD_MODIFIED_AT, FIELD_TYPE

Constructor Summary

Constructors

Constructor and Description
BoxFile() Constructor.
BoxFile(BoxFile obj) Copy constructor, this does deep copy for all the fields.
BoxFile(IBoxParcelWrapper in)
BoxFile(java.util.Map<java.lang.String,java.lang.Object> map) Instantiate the object from a map.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Date	dateContentCreatedAt() Return the date content created on local machine, if this date was not provided when uploading the file, this will be the time file was uploaded.
java.util.Date	dateContentModifieddAt() Return the date content last modified on local machine, if this date was not provided when uploading the file, this will be the time file was uploaded.
java.util.Date	datePurgedAt() Return the date this file will be permanently deleted.
java.util.Date	dateTrashedAt() Return the date file was last moved to the trash.
java.lang.Integer	getCommentCount() Get comment count of the file.
java.lang.String	getContentCreatedAt()
java.lang.String	getContentModifiedAt()
java.lang.String	getExtension() Get extension of the file.
BoxLock	getLock() Get lock on this file.
java.lang.String	getPurgedAt()
java.lang.String	getSha1() Get sha1 of the file.
java.lang.String	getTrashedAt()
java.lang.String	getVersionNumber() Get version number of the file.
protected void	setLock(BoxLock lock) Set the lock.

Methods inherited from class com.box.boxjavalibv2.dao.BoxItem

getAllowedSharedLinkAccessLevels, getCollections, getCreatedBy, getDescription, getEtag, getItemStatus, getModifiedBy, getName, getOwnedBy, getParent, getPathCollection, getPermissions, getSequenceId, getSharedLink, getSize, getTags, isFavorited

Methods inherited from class com.box.boxjavalibv2.dao.BoxTypedObject

dateCreatedAt, dateModifiedAt, getCreatedAt, getId, getModifiedAt, getType, resourceType, setType

Methods inherited from class com.box.boxjavalibv2.dao.BoxObject

canBeHandledAsUnknown, contains, equals, extraProperties, getExtraData, getValue, handleUnknown, hashCode, properties, put, writeToParcel

Methods inherited from class java.lang.Object

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

Field Detail

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_COMMENT_COUNT

public static final java.lang.String FIELD_COMMENT_COUNT

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_TRASHED_AT

public static final java.lang.String FIELD_TRASHED_AT

See Also:

Constant Field Values

FIELD_PURGED_AT

public static final java.lang.String FIELD_PURGED_AT

See Also:

Constant Field Values

FIELD_LOCK

public static final java.lang.String FIELD_LOCK

See Also:

Constant Field Values

FIELD_EXTENSION

public static final java.lang.String FIELD_EXTENSION

See Also:

Constant Field Values

Constructor Detail

BoxFile

public BoxFile()

Constructor.

BoxFile

public BoxFile(BoxFile obj)

Copy constructor, this does deep copy for all the fields.

Parameters:

obj -

BoxFile

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

Instantiate the object from a map. Each entry in the map reflects to a field.

Parameters:

map -

BoxFile

public BoxFile(IBoxParcelWrapper in)

Method Detail

getSha1

public java.lang.String getSha1()

Get sha1 of the file.

Returns:

sha1 of the file.

getContentCreatedAt

public java.lang.String getContentCreatedAt()

dateContentCreatedAt

public java.util.Date dateContentCreatedAt()

Return the date content created on local machine, if this date was not provided when uploading the file, this will be the time file was uploaded.

Returns:

getContentModifiedAt

public java.lang.String getContentModifiedAt()

dateContentModifieddAt

public java.util.Date dateContentModifieddAt()

Return the date content last modified on local machine, if this date was not provided when uploading the file, this will be the time file was uploaded.

Returns:

getVersionNumber

public java.lang.String getVersionNumber()

Get version number of the file.

Returns:

version number of the file.

getCommentCount

public java.lang.Integer getCommentCount()

Get comment count of the file.

Returns:

comment count of the file.

getTrashedAt

public java.lang.String getTrashedAt()

dateTrashedAt

public java.util.Date dateTrashedAt()

Return the date file was last moved to the trash.

Returns:

the date file was last moved to the trash.

getPurgedAt

public java.lang.String getPurgedAt()

datePurgedAt

public java.util.Date datePurgedAt()

Return the date this file will be permanently deleted.

Returns:

the date this file will be permanently deleted.

getLock

public BoxLock getLock()

Get lock on this file.

Returns:

lock on the file

setLock

protected void setLock(BoxLock lock)

Set the lock.

Parameters:

lock - lock

getExtension

public java.lang.String getExtension()

Get extension of the file.

Returns:

extension of the file.