org.springframework.data.mongodb.gridfs

Class GridFsObject.Options

java.lang.Object

org.springframework.data.mongodb.gridfs.GridFsObject.Options

Enclosing interface:

GridFsObject<ID,CONTENT>

public static class GridFsObject.Options
extends Object

Additional, context relevant information.

Author:

Christoph Strobl

Method Summary

Modifier and Type	Method and Description
GridFsObject.Options	chunkSize(int chunkSize)
GridFsObject.Options	contentType(String contentType) Set the associated content type.
static GridFsObject.Options	from(com.mongodb.client.gridfs.model.GridFSFile gridFSFile) Static factory method to create GridFsObject.Options by extracting information from the given GridFSFile.
int	getChunkSize()
org.bson.Document	getMetadata()
GridFsObject.Options	metadata(org.bson.Document metadata)
static GridFsObject.Options	none() Static factory to create empty options.
static GridFsObject.Options	typed(String contentType) Static factory method to create GridFsObject.Options with given content type.

Methods inherited from class java.lang.Object

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

Method Detail

none

public static GridFsObject.Options none()

Static factory to create empty options.

Returns:

new instance of GridFsObject.Options.

typed

public static GridFsObject.Options typed(String contentType)

Static factory method to create GridFsObject.Options with given content type.

Parameters:

contentType -

Returns:

new instance of GridFsObject.Options.

from

public static GridFsObject.Options from(@Nullable
                                        com.mongodb.client.gridfs.model.GridFSFile gridFSFile)

Static factory method to create GridFsObject.Options by extracting information from the given GridFSFile.

Parameters:

gridFSFile - can be null, returns none() in that case.

Returns:

new instance of GridFsObject.Options.

contentType

public GridFsObject.Options contentType(String contentType)

Set the associated content type.

Parameters:

contentType - must not be null.

Returns:

new instance of GridFsObject.Options.

metadata

public GridFsObject.Options metadata(org.bson.Document metadata)

Parameters:

metadata -

Returns:

new instance of GridFsObject.Options.

chunkSize

public GridFsObject.Options chunkSize(int chunkSize)

Parameters:

chunkSize - the file chunk size to use.

Returns:

new instance of GridFsObject.Options.

getMetadata

public org.bson.Document getMetadata()

Returns:

never null.

getChunkSize

public int getChunkSize()

Returns:

the chunk size to use.