org.springframework.data.mongodb.gridfs

Class GridFsUpload<ID>

java.lang.Object

org.springframework.data.mongodb.gridfs.GridFsUpload<ID>

All Implemented Interfaces:

GridFsObject<ID,InputStream>

public class GridFsUpload<ID>
extends Object
implements GridFsObject<ID,InputStream>

Upload descriptor for a GridFS file upload.

Since:

3.0

Author:

Christoph Strobl, Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GridFsUpload.GridFsUploadBuilder<T> Builder to create GridFsUpload in a fluent way.

Nested classes/interfaces inherited from interface org.springframework.data.mongodb.gridfs.GridFsObject

GridFsObject.Options

Method Summary

Modifier and Type	Method and Description
static GridFsUpload.GridFsUploadBuilder<org.bson.types.ObjectId>	fromStream(InputStream stream) Create a new instance of GridFsUpload for the given InputStream.
InputStream	getContent() The actual file content.
ID	getFileId() The GridFSFile.getId() value converted into its simple java type.
String	getFilename() The filename.
GridFsObject.Options	getOptions() Additional information like file metadata (eg. contentType).

Methods inherited from class java.lang.Object

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

Method Detail

getFileId

@Nullable
public ID getFileId()

The GridFSFile.getId() value converted into its simple java type.
A BsonString will be converted to plain String.

Specified by:

getFileId in interface GridFsObject<ID,InputStream>

Returns:

can be null.

See Also:

GridFsObject.getFileId()

getFilename

public String getFilename()

Description copied from interface: GridFsObject

The filename.

Specified by:

getFilename in interface GridFsObject<ID,InputStream>

Returns:

getContent

public InputStream getContent()

Description copied from interface: GridFsObject

The actual file content.

Specified by:

getContent in interface GridFsObject<ID,InputStream>

Returns:

getOptions

public GridFsObject.Options getOptions()

Description copied from interface: GridFsObject

Additional information like file metadata (eg. contentType).

Specified by:

getOptions in interface GridFsObject<ID,InputStream>

Returns:

never null.

fromStream

public static GridFsUpload.GridFsUploadBuilder<org.bson.types.ObjectId> fromStream(InputStream stream)

Create a new instance of GridFsUpload for the given InputStream.

Parameters:

stream - must not be null.

Returns:

new instance of GridFsUpload.