Package org.springframework.data.mongodb.gridfs

Class GridFsUpload.GridFsUploadBuilder<T>

java.lang.Object

org.springframework.data.mongodb.gridfs.GridFsUpload.GridFsUploadBuilder<T>

Type Parameters:

T - the target id type.

Enclosing class:

GridFsUpload<ID>

public static class GridFsUpload.GridFsUploadBuilder<T>
extends Object

Builder to create GridFsUpload in a fluent way.

Method Summary

Modifier and Type	Method	Description
GridFsUpload<T>	build()
GridFsUpload.GridFsUploadBuilder<T>	chunkSize(int chunkSize)	Set the upload chunk size in bytes.
GridFsUpload.GridFsUploadBuilder<T>	content(InputStream stream)	Define the content of the file to upload.
GridFsUpload.GridFsUploadBuilder<T>	content(Supplier<InputStream> stream)	Define the content of the file to upload.
GridFsUpload.GridFsUploadBuilder<T>	contentType(String contentType)	Set the content type.
GridFsUpload.GridFsUploadBuilder<T>	filename(String filename)	Set the filename.
GridFsUpload.GridFsUploadBuilder<T>	gridFsFile(com.mongodb.client.gridfs.model.GridFSFile gridFSFile)	Set id, filename, metadata and chunk size from given file.
<T1> GridFsUpload.GridFsUploadBuilder<T1>	id(T1 id)	Set the id to use.
GridFsUpload.GridFsUploadBuilder<T>	metadata(org.bson.Document metadata)	Set the file metadata.
GridFsUpload.GridFsUploadBuilder<T>	options(GridFsObject.Options options)	Set additional file information.

Methods inherited from class java.lang.Object

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

Method Details

content

public GridFsUpload.GridFsUploadBuilder<T> content(InputStream stream)

Define the content of the file to upload.

Parameters:

stream - the upload content.

Returns:

this.

content

public GridFsUpload.GridFsUploadBuilder<T> content(Supplier<InputStream> stream)

Define the content of the file to upload.

Parameters:

stream - the upload content.

Returns:

this.

id

public <T1> GridFsUpload.GridFsUploadBuilder<T1> id(T1 id)

Set the id to use.

Type Parameters:

T1 -

Parameters:

id - the id to save the content to.

Returns:

this.

filename

public GridFsUpload.GridFsUploadBuilder<T> filename(String filename)

Set the filename.

Parameters:

filename - the filename to use.

Returns:

this.

options

public GridFsUpload.GridFsUploadBuilder<T> options(GridFsObject.Options options)

Set additional file information.

Parameters:

options - must not be null.

Returns:

this.

metadata

public GridFsUpload.GridFsUploadBuilder<T> metadata(org.bson.Document metadata)

Set the file metadata.

Parameters:

metadata - must not be null.

Returns:

this.

chunkSize

public GridFsUpload.GridFsUploadBuilder<T> chunkSize(int chunkSize)

Set the upload chunk size in bytes.

Parameters:

chunkSize - use negative number for default.

Returns:

this.

gridFsFile

public GridFsUpload.GridFsUploadBuilder<T> gridFsFile(com.mongodb.client.gridfs.model.GridFSFile gridFSFile)

Set id, filename, metadata and chunk size from given file.

Parameters:

gridFSFile - must not be null.

Returns:

this.

contentType

public GridFsUpload.GridFsUploadBuilder<T> contentType(String contentType)

Set the content type.

Parameters:

contentType - must not be null.

Returns:

this.

build

public GridFsUpload<T> build()