com.box.sdk

Class BoxFileVersion

Object

BoxResource

BoxFileVersion

@BoxResourceType(value="file_version")
public class BoxFileVersion
extends BoxResource

Represents a particular version of a file on Box.

Nested Class Summary

Nested classes/interfaces inherited from class BoxResource

BoxResource.Info

Field Summary

Fields

Modifier and Type	Field and Description
static URLTemplate	CONTENT_URL_TEMPLATE Content URL Template.
static long	DEFAULT_LIMIT The default limit of entries per response.
static URLTemplate	VERSION_URL_TEMPLATE Version URL Template.

Constructor Summary

Constructors

Constructor and Description
BoxFileVersion(BoxAPIConnection api, String json, String fileID) Constructs a BoxFileVersion from a JSON string.

Method Summary

Modifier and Type	Method and Description
void	delete() Deletes this version of the file.
void	download(OutputStream output) Downloads this version of the file to a given OutputStream.
void	download(OutputStream output, ProgressListener listener) Downloads this version of the file to a given OutputStream while reporting the progress to a ProgressListener.
Date	getCreatedAt() Gets the time that this version of the file was created.
String	getFileID()
Date	getModifiedAt() Gets the time that this version of the file was modified.
BoxUser.Info	getModifiedBy() Gets information about the user who last modified this version of the file.
String	getName() Gets the name of this version of the file.
Date	getPurgedAt() Gets the time that this version of the file was purged.
Date	getRestoredAt() Gets the time that this version of the file was restored.
BoxUser.Info	getRestoredBy() Gets information about the user who restored this version of the file.
String	getSha1() Gets the SHA1 hash of this version of the file.
long	getSize() Gets the size of this version of the file.
Date	getTrashedAt() Gets the time that this version of the file was deleted.
BoxUser.Info	getTrashedBy() Gets information about the user who trashed this version of the file.
String	getUploaderDisplayName() Gets the user's name at the time of upload.
String	getVersionID() Gets the version ID of this version of the file.
Long	getVersionNumber() Returns version number.
void	promote() Promotes this version of the file to be the latest version.
void	setFileID(String fileID) Used if no or wrong file id was set with constructor.

Methods inherited from class BoxResource

equals, getAPI, getID, getResourceType, hashCode

Methods inherited from class Object

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

Field Detail

CONTENT_URL_TEMPLATE

public static final URLTemplate CONTENT_URL_TEMPLATE

Content URL Template.

VERSION_URL_TEMPLATE

public static final URLTemplate VERSION_URL_TEMPLATE

Version URL Template.

DEFAULT_LIMIT

public static final long DEFAULT_LIMIT

The default limit of entries per response.

See Also:

Constant Field Values

Constructor Detail

BoxFileVersion

public BoxFileVersion(BoxAPIConnection api,
                      String json,
                      String fileID)

Constructs a BoxFileVersion from a JSON string.

Parameters:

api - the API connection to be used by the file.

json - the JSON encoded file version.

fileID - the ID of the file.

Method Detail

getFileID

public String getFileID()

Returns:

the file id this file version belongs to.

setFileID

public void setFileID(String fileID)

Used if no or wrong file id was set with constructor.

Parameters:

fileID - the file id this file version belongs to.

getVersionID

public String getVersionID()

Gets the version ID of this version of the file.

Returns:

the version ID of this version of the file.

getSha1

public String getSha1()

Gets the SHA1 hash of this version of the file.

Returns:

the SHA1 hash of this version of the file.

getName

public String getName()

Gets the name of this version of the file.

Returns:

the name of this version of the file.

getSize

public long getSize()

Gets the size of this version of the file.

Returns:

the size of this version of the file.

getCreatedAt

public Date getCreatedAt()

Gets the time that this version of the file was created.

Returns:

the time that this version of the file was created.

getUploaderDisplayName

public String getUploaderDisplayName()

Gets the user's name at the time of upload.

Returns:

the time user's name at the time of upload.

getModifiedAt

public Date getModifiedAt()

Gets the time that this version of the file was modified.

Returns:

the time that this version of the file was modified.

getTrashedAt

public Date getTrashedAt()

Gets the time that this version of the file was deleted.

Returns:

the time that this version of the file was deleted.

getTrashedBy

public BoxUser.Info getTrashedBy()

Gets information about the user who trashed this version of the file.

Returns:

info about the user who trashed this version of the file.

getModifiedBy

public BoxUser.Info getModifiedBy()

Gets information about the user who last modified this version of the file.

Returns:

info about the user who last modified this version of the file.

getRestoredAt

public Date getRestoredAt()

Gets the time that this version of the file was restored.

Returns:

the time that this version of the file was restored.

getRestoredBy

public BoxUser.Info getRestoredBy()

Gets information about the user who restored this version of the file.

Returns:

info about the user who restored this version of the file.

getPurgedAt

public Date getPurgedAt()

Gets the time that this version of the file was purged.

Returns:

the time that this version of the file was purged.

getVersionNumber

public Long getVersionNumber()

Returns version number.

Returns:

version number

delete

public void delete()

Deletes this version of the file.

download

public void download(OutputStream output)

Downloads this version of the file to a given OutputStream.

Parameters:

output - the stream to where the file will be written.

download

public void download(OutputStream output,
                     ProgressListener listener)

Downloads this version of the file to a given OutputStream while reporting the progress to a ProgressListener.

Parameters:

output - the stream to where the file will be written.

listener - a listener for monitoring the download's progress.

promote

public void promote()

Promotes this version of the file to be the latest version.