Package com.mongodb.client.gridfs
Class GridFSUploadStream
java.lang.Object
java.io.OutputStream
com.mongodb.client.gridfs.GridFSUploadStream
- All Implemented Interfaces:
Closeable
,Flushable
,AutoCloseable
A GridFS OutputStream for uploading data into GridFS
Provides the id
for the file to be uploaded as well as the write
methods of a OutputStream
This implementation of a OutputStream
will not throw IOException
s. However, it will throw a
MongoException
if there is an error writing to MongoDB.
- Since:
- 3.1
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionabstract void
abort()
Aborts the upload and deletes any data.abstract void
close()
void
flush()
abstract BsonValue
getId()
Gets theBsonValue
for the file to be uploadedabstract ObjectId
Gets theObjectId
for the file to be uploaded or throws an error if an alternative BsonType has been used for the id.abstract void
write
(byte[] b) abstract void
write
(byte[] b, int off, int len) abstract void
write
(int b) Methods inherited from class java.io.OutputStream
nullOutputStream
-
Constructor Details
-
GridFSUploadStream
public GridFSUploadStream()
-
-
Method Details
-
getObjectId
Gets theObjectId
for the file to be uploaded or throws an error if an alternative BsonType has been used for the id. Throws a MongoGridFSException if the file id is not an ObjectId.- Returns:
- the ObjectId for the file to be uploaded
-
getId
Gets theBsonValue
for the file to be uploaded- Returns:
- the BsonValue for the file to be uploaded
-
abort
public abstract void abort()Aborts the upload and deletes any data. -
write
public abstract void write(int b) - Specified by:
write
in classOutputStream
-
write
public abstract void write(byte[] b) - Overrides:
write
in classOutputStream
-
write
public abstract void write(byte[] b, int off, int len) - Overrides:
write
in classOutputStream
-
flush
public void flush()- Specified by:
flush
in interfaceFlushable
- Overrides:
flush
in classOutputStream
-
close
public abstract void close()- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Overrides:
close
in classOutputStream
-