Class ProgressReportingRequestBody.Builder

java.lang.Object

com.amilesend.client.connection.file.ProgressReportingRequestBody.Builder

Enclosing class:

ProgressReportingRequestBody

public static class ProgressReportingRequestBody.Builder
extends Object

The builder used to construct new ProgressReportingRequestBody instances for uploads.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ProgressReportingRequestBody	build()	Builds a new RequestBody that tracks the transfer progress for multipart form-data transfer.
ProgressReportingRequestBody.Builder	callback(TransferProgressCallback callback)	The callback listener.
ProgressReportingRequestBody.Builder	contentType(String contentType)	The content type.
ProgressReportingRequestBody.Builder	destination(String destination)	The destination descriptor (i.e., the name of the service).
ProgressReportingRequestBody.Builder	file(Path file)	The file to upload.

Methods inherited from class Object

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

Constructor Details

Builder

public Builder()

Method Details

file

public ProgressReportingRequestBody.Builder file(Path file)

The file to upload.

Parameters:

file - the path of the file to upload

Returns:

the builder

contentType

public ProgressReportingRequestBody.Builder contentType(String contentType)

The content type. The default is text/csv.

Parameters:

contentType - the content type

Returns:

the builder

destination

public ProgressReportingRequestBody.Builder destination(String destination)

The destination descriptor (i.e., the name of the service).

Parameters:

destination - the destination

Returns:

the builder

callback

public ProgressReportingRequestBody.Builder callback(TransferProgressCallback callback)

The callback listener. Default is a LogProgressCallback.

Parameters:

callback - the listener

Returns:

the builder

build

public ProgressReportingRequestBody build()
                                   throws IOException

Builds a new RequestBody that tracks the transfer progress for multipart form-data transfer.

Returns:

the request body

Throws:

IOException - if an error occurred while accessing the file to read