com.vmware.content.library.item.downloadsession

Class FileTypes.Info.Builder

java.lang.Object

com.vmware.content.library.item.downloadsession.FileTypes.Info.Builder

Enclosing class:

FileTypes.Info

public static final class FileTypes.Info.Builder
extends Object

Builder class for FileTypes.Info.

Constructor Summary

Constructors

Constructor and Description
FileTypes.Info.Builder(String name, long bytesTransferred, FileTypes.PrepareStatus status) Constructor with parameters for the required properties of FileTypes.Info.

Method Summary

Methods

Modifier and Type	Method and Description
FileTypes.Info	build()
FileTypes.Info.Builder	setChecksumInfo(FileTypes.ChecksumInfo checksumInfo) The checksum information of the file.
FileTypes.Info.Builder	setDownloadEndpoint(TransferEndpoint downloadEndpoint) Endpoint at which the file is available for download.
FileTypes.Info.Builder	setErrorMessage(LocalizableMessage errorMessage) Error message for a failed preparation when the prepare status is FileTypes.PrepareStatus.ERROR.
FileTypes.Info.Builder	setSize(Long size) The file size, in bytes.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileTypes.Info.Builder

public FileTypes.Info.Builder(String name,
                      long bytesTransferred,
                      FileTypes.PrepareStatus status)

Constructor with parameters for the required properties of FileTypes.Info.

Method Detail

setSize

public FileTypes.Info.Builder setSize(Long size)

The file size, in bytes. This property may not be available immediately. It is guaranteed to be set when the client finishes downloading the file.

Parameters:

size - New value for the property.

setDownloadEndpoint

public FileTypes.Info.Builder setDownloadEndpoint(TransferEndpoint downloadEndpoint)

Endpoint at which the file is available for download. The value is valid only when the FileTypes.Info.getStatus() is FileTypes.PrepareStatus.PREPARED. This property won't be set until the file status is FileTypes.PrepareStatus.PREPARED.

Parameters:

downloadEndpoint - New value for the property.

setChecksumInfo

public FileTypes.Info.Builder setChecksumInfo(FileTypes.ChecksumInfo checksumInfo)

The checksum information of the file. When the download is complete, you can retrieve the checksum from the File.get(java.lang.String, java.lang.String) method to verify the checksum for the downloaded file. The checksum is always calculated for the downloaded file, but this property won't be set until the download is complete.

Parameters:

checksumInfo - New value for the property.

setErrorMessage

public FileTypes.Info.Builder setErrorMessage(LocalizableMessage errorMessage)

Error message for a failed preparation when the prepare status is FileTypes.PrepareStatus.ERROR. This property won't be set unless there was an error with the file transfer.

Parameters:

errorMessage - New value for the property.

build

public FileTypes.Info build()