com.box.sdk

Class BoxFile.Info

Object

BoxJSONObject

BoxResource.Info

BoxItem.Info

BoxFile.Info

Enclosing class:

BoxFile

public class BoxFile.Info
extends BoxItem.Info

Contains information about a BoxFile.

Constructor Summary

Constructors

Constructor and Description
BoxFile.Info() Constructs an empty Info object.
BoxFile.Info(String json) Constructs an Info object by parsing information from a JSON string.

Method Summary

Methods

Modifier and Type	Method and Description
long	getCommentCount() Gets the number of comments on the file.
String	getExtension() Gets the extension suffix of the file, excluding the dot.
boolean	getIsPackage() Gets whether or not the file is an OSX package.
EnumSet<BoxFile.Permission>	getPermissions() Gets the permissions that the current user has on the file.
BoxFile	getResource() Gets the resource associated with this Info.
String	getSha1() Gets the SHA1 hash of the file.
String	getVersionNumber() Gets the current version number of the file.
protected void	parseJSONMember(JsonObject.Member member) Invoked with a JSON member whenever this object is updated or created from a JSON object.

Methods inherited from class BoxItem.Info

getContentCreatedAt, getContentModifiedAt, getCreatedAt, getCreatedBy, getDescription, getEtag, getItemStatus, getModifiedAt, getModifiedBy, getName, getOwnedBy, getParent, getPathCollection, getPurgedAt, getSequenceID, getSharedLink, getSize, getTags, getTrashedAt, setDescription, setName, setSharedLink

Methods inherited from class BoxResource.Info

getID

Methods inherited from class BoxJSONObject

clearPendingChanges, getPendingChanges

Methods inherited from class Object

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

Constructor Detail

BoxFile.Info

public BoxFile.Info()

Constructs an empty Info object.

BoxFile.Info

public BoxFile.Info(String json)

Constructs an Info object by parsing information from a JSON string.

Parameters:

json - the JSON string to parse.

Method Detail

getResource

public BoxFile getResource()

Description copied from class: BoxResource.Info

Gets the resource associated with this Info.

Specified by:

getResource in class BoxResource.Info

Returns:

the associated resource.

getSha1

public String getSha1()

Gets the SHA1 hash of the file.

Returns:

the SHA1 hash of the file.

getVersionNumber

public String getVersionNumber()

Gets the current version number of the file.

Returns:

the current version number of the file.

getCommentCount

public long getCommentCount()

Gets the number of comments on the file.

Returns:

the number of comments on the file.

getPermissions

public 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 String getExtension()

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

Returns:

the extension of the file.

getIsPackage

public boolean getIsPackage()

Gets whether or not the file is an OSX package.

Returns:

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

parseJSONMember

protected void parseJSONMember(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.Info

Parameters:

member - the JSON member to be parsed.