Package com.mongodb.client.gridfs.model

Class GridFSFile

java.lang.Object
com.mongodb.client.gridfs.model.GridFSFile
@Deprecated(since="2021-05-27") public final class GridFSFile extends Object
Deprecated.
Usage of this API is not supported in AEM as a Cloud Service.
The GridFSFile
Since:
3.1

  • Constructor Details

    • GridFSFile

      @Deprecated public GridFSFile(BsonValue id, String filename, long length, int chunkSize, Date uploadDate, @Nullable String md5, Document metadata)
      Deprecated.
      there is no replacement for this constructor
      Creates a new GridFSFile
      Parameters:
      id - the id of the file
      filename - the filename
      length - the length, in bytes of the file
      chunkSize - the chunkSize, in bytes of the file
      uploadDate - the upload date of the file
      md5 - the hash of the files contents
      metadata - the optional metadata for the file

    • GridFSFile

      @Deprecated public GridFSFile(BsonValue id, String filename, long length, int chunkSize, Date uploadDate, @Nullable String md5, @Nullable Document metadata, @Nullable Document extraElements)
      Deprecated.
      there is no replacement for this constructor
      Creates a legacy implementation of the GridFSFile

      For GridFS files created in older versions of the driver.

      Parameters:
      id - the id of the file
      filename - the filename
      length - the length, in bytes of the file
      chunkSize - the chunkSize, in bytes of the file
      uploadDate - the upload date of the file
      md5 - the hash of the files contents
      metadata - the optional metadata for the file
      extraElements - any extra data stored in the document

  • Method Details

    • getObjectId

      public ObjectId getObjectId()
      Deprecated.
      The ObjectId for this file. Throws a MongoGridFSException if the file id is not an ObjectId.
      Returns:
      the id for this file.

    • getId

      public BsonValue getId()
      Deprecated.
      The BsonValue id for this file.
      Returns:
      the id for this file

    • getFilename

      public String getFilename()
      Deprecated.
      The filename
      Returns:
      the filename

    • getLength

      public long getLength()
      Deprecated.
      The length, in bytes of this file
      Returns:
      the length, in bytes of this file

    • getChunkSize

      public int getChunkSize()
      Deprecated.
      The size, in bytes, of each data chunk of this file
      Returns:
      the size, in bytes, of each data chunk of this file

    • getUploadDate

      public Date getUploadDate()
      Deprecated.
      The date and time this file was added to GridFS
      Returns:
      the date and time this file was added to GridFS

    • getMD5

      @Deprecated @Nullable public String getMD5()
      Deprecated.
      file hashing is deprecated and may be removed in the future.
      The hash of the contents of the stored file
      Returns:
      the hash of the contents of the stored file or null if hashing the contents was disabled.

    • getMetadata

      @Nullable public Document getMetadata()
      Deprecated.
      Any additional metadata stored along with the file
      Returns:
      the metadata document or null

    • getExtraElements

      @Deprecated @Nullable public Document getExtraElements()
      Deprecated.
      any extra information should be stored in the metadata document instead.
      All deprecated top level elements including any contentType or aliases data
      Returns:
      the extra elements document or null

    • getContentType

      @Deprecated public String getContentType()
      Deprecated.
      content type information should be stored the metadata document instead.
      The content type of the file
      Returns:
      the content type of the file

    • getAliases

      @Deprecated public List<String> getAliases()
      Deprecated.
      any aliases should be stored in the metadata document instead.
      The aliases for the file
      Returns:
      the aliases of the file

    • equals

      public boolean equals(Object o)
      Deprecated.
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Deprecated.
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Deprecated.
      Overrides:
      toString in class Object