com.mongodb.gridfs

Class GridFSInputFile

java.lang.Object

com.mongodb.gridfs.GridFSFile

com.mongodb.gridfs.GridFSInputFile

All Implemented Interfaces:

DBObject, BSONObject

public class GridFSInputFile
extends GridFSFile

This class represents a GridFS file to be written to the database. Operations include:

• Writing data obtained from an InputStream
• Getting an OutputStream to stream the data out to

Method Summary

Modifier and Type	Method and Description
java.io.OutputStream	getOutputStream() After retrieving this OutputStream, this object will be capable of accepting successively written data to the output stream.
void	save() Calls save(long) with the existing chunk size.
void	save(long chunkSize) This method first calls saveChunks(long) if the file data has not been saved yet.
int	saveChunks() Saves all data into chunks from configured InputStream input stream to GridFS.
int	saveChunks(long chunkSize) Saves all data into chunks from configured InputStream input stream to GridFS.
void	setChunkSize(long chunkSize) Set the chunk size.
void	setContentType(java.lang.String contentType) Sets the content type (MIME type) on the GridFS entry.
void	setFilename(java.lang.String filename) Sets the file name on the GridFS entry.
void	setId(java.lang.Object id) Sets the ID of this GridFS file.

Methods inherited from class com.mongodb.gridfs.GridFSFile

containsField, containsKey, get, getAliases, getChunkSize, getContentType, getFilename, getId, getLength, getMD5, getMetaData, getUploadDate, isPartialObject, keySet, markAsPartialObject, numChunks, put, putAll, putAll, removeField, setMetaData, toMap, toString, validate

Methods inherited from class java.lang.Object

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

Method Detail

setId

public void setId(java.lang.Object id)

Sets the ID of this GridFS file.

Parameters:

id - the file's ID.

setFilename

public void setFilename(java.lang.String filename)

Sets the file name on the GridFS entry.

Parameters:

filename - File name.

setContentType

public void setContentType(java.lang.String contentType)

Sets the content type (MIME type) on the GridFS entry.

Parameters:

contentType - Content type.

setChunkSize

public void setChunkSize(long chunkSize)

Set the chunk size. This must be called before saving any data.

Parameters:

chunkSize - The size in bytes.

save

public void save()

Calls save(long) with the existing chunk size.

Overrides:

save in class GridFSFile

Throws:

MongoException - if there's a problem saving the file.

save

public void save(long chunkSize)

This method first calls saveChunks(long) if the file data has not been saved yet. Then it persists the file entry to GridFS.

Parameters:

chunkSize - Size of chunks for file in bytes.

Throws:

MongoException - if there's a problem saving the file.

saveChunks

public int saveChunks()
               throws java.io.IOException

Saves all data into chunks from configured InputStream input stream to GridFS.

Returns:

Number of the next chunk.

Throws:

java.io.IOException - on problems reading the new entry's InputStream.

MongoException - if there's a failure

See Also:

saveChunks(long)

saveChunks

public int saveChunks(long chunkSize)
               throws java.io.IOException

Saves all data into chunks from configured InputStream input stream to GridFS. A non-default chunk size can be specified. This method does NOT save the file object itself, one must call save() to do so.

Parameters:

chunkSize - Size of chunks for file in bytes.

Returns:

Number of the next chunk.

Throws:

java.io.IOException - on problems reading the new entry's InputStream.

MongoException - if there's a failure

getOutputStream

public java.io.OutputStream getOutputStream()

After retrieving this OutputStream, this object will be capable of accepting successively written data to the output stream. To completely persist this GridFS object, you must finally call the OutputStream.close() method on the output stream. Note that calling the save() and saveChunks() methods will throw Exceptions once you obtained the OutputStream.

Returns:

Writable stream object.