Package io.jmix.flowui.download

Record Class DownloadContext

java.lang.Object
java.lang.Record
io.jmix.flowui.download.DownloadContext
Record Components:
dataProvider - the provider supplying the data to be downloaded
fileName - the name of the file to be downloaded
contentType - the MIME type of the file
cacheMaxAgeSec - the maximum time in seconds the file will be considered relevant for caching purposes
download - true if the file should be downloaded, false if it should be viewed
public record DownloadContext(DownloadDataProvider dataProvider, String fileName, String contentType, int cacheMaxAgeSec, boolean download) extends Record
Represents the context for a file download operation. This class encapsulates relevant metadata and data provider information to facilitate the downloading of a file.

  • Constructor Details

    • DownloadContext

      public DownloadContext(DownloadDataProvider dataProvider, String fileName, String contentType, int cacheMaxAgeSec, boolean download)
      Creates an instance of a DownloadContext record class.
      Parameters:
      dataProvider - the value for the dataProvider record component
      fileName - the value for the fileName record component
      contentType - the value for the contentType record component
      cacheMaxAgeSec - the value for the cacheMaxAgeSec record component
      download - the value for the download record component

  • Method Details

    • cacheMaxAgeSec

      public int cacheMaxAgeSec()
      Returns the maximum time in seconds during which the file will be considered relevant. Makes sense for using the built-in PDF viewer in the Chrome browser.
      See Also:

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • dataProvider

      public DownloadDataProvider dataProvider()
      Returns the value of the dataProvider record component.
      Returns:
      the value of the dataProvider record component

    • fileName

      public String fileName()
      Returns the value of the fileName record component.
      Returns:
      the value of the fileName record component

    • contentType

      public String contentType()
      Returns the value of the contentType record component.
      Returns:
      the value of the contentType record component

    • download

      public boolean download()
      Returns the value of the download record component.
      Returns:
      the value of the download record component