Package com.mongodb.client.gridfs.model

Class GridFSDownloadOptions

  • public final class GridFSDownloadOptions
extends java.lang.Object
    The GridFS download by name options

    Controls the selection of the revision to download

    Since:
    3.3

    • Constructor Summary

      Constructors 
      Constructor Description
      GridFSDownloadOptions()
      Download the most recent version of the file.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getRevision()
      Gets the revision to download identifier
      GridFSDownloadOptions revision​(int revision)
      Set the revision of the file to retrieve.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • GridFSDownloadOptions

        public GridFSDownloadOptions()
        Download the most recent version of the file.

        Defaults to the most recent revision.

    • Method Detail

      • revision

        public GridFSDownloadOptions revision​(int revision)
        Set the revision of the file to retrieve.

        Revision numbers are defined as follows:

        • 0 = the original stored file
        • 1 = the first revision
        • 2 = the second revision
        • etc..
        • -2 = the second most recent revision
        • -1 = the most recent revision
        Parameters:
        revision - the file revision to download
        Returns:
        this

      • getRevision

        public int getRevision()
        Gets the revision to download identifier
        Returns:
        the revision to download identifier