Module com.github.librepdf.openpdf.parent
Package org.openpdf.html

Record Class HtmlToPdfBatchUtils.HtmlFileStreamJob

java.lang.Object
java.lang.Record
org.openpdf.html.HtmlToPdfBatchUtils.HtmlFileStreamJob
Enclosing class:
HtmlToPdfBatchUtils
public static record HtmlToPdfBatchUtils.HtmlFileStreamJob(Path htmlFile, Path baseDir, OutputStream outputStream, Optional<String> injectCss, Optional<Consumer<ITextRenderer>> rendererCustomizer) extends Record
Render an HTML file (and its relative assets) to a pre-opened OutputStream.

Concurrency note: Each job in a batch runs on its own virtual thread. Every job in the batch must use a distinct OutputStream instance — sharing a stream between jobs will corrupt the output. The caller is responsible for closing the stream after the batch completes.

  • Constructor Details

    • HtmlFileStreamJob

      public HtmlFileStreamJob(Path htmlFile, Path baseDir, OutputStream outputStream, Optional<String> injectCss, Optional<Consumer<ITextRenderer>> rendererCustomizer)
      Creates an instance of a HtmlFileStreamJob record class.
      Parameters:
      htmlFile - the value for the htmlFile record component
      baseDir - the value for the baseDir record component
      outputStream - the value for the outputStream record component
      injectCss - the value for the injectCss record component
      rendererCustomizer - the value for the rendererCustomizer record component

  • Method Details

    • 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • htmlFile

      public Path htmlFile()
      Returns the value of the htmlFile record component.
      Returns:
      the value of the htmlFile record component

    • baseDir

      public Path baseDir()
      Returns the value of the baseDir record component.
      Returns:
      the value of the baseDir record component

    • outputStream

      public OutputStream outputStream()
      Returns the value of the outputStream record component.
      Returns:
      the value of the outputStream record component

    • injectCss

      public Optional<String> injectCss()
      Returns the value of the injectCss record component.
      Returns:
      the value of the injectCss record component

    • rendererCustomizer

      public Optional<Consumer<ITextRenderer>> rendererCustomizer()
      Returns the value of the rendererCustomizer record component.
      Returns:
      the value of the rendererCustomizer record component