Record Class MjmlRenderResult

java.lang.Object
java.lang.Record
dev.jcputney.mjml.MjmlRenderResult
Record Components:
html - the rendered HTML string
title - the document title extracted from mj-title, or empty string
previewText - the preview text extracted from mj-preview, or empty string

public record MjmlRenderResult(String html, String title, String previewText) extends Record
Result of rendering an MJML template to HTML.
  • Constructor Details

    • MjmlRenderResult

      public MjmlRenderResult(String html, String title, String previewText)
      Creates an instance of a MjmlRenderResult record class.
      Parameters:
      html - the value for the html record component
      title - the value for the title record component
      previewText - the value for the previewText 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.
    • html

      public String html()
      Returns the value of the html record component.
      Returns:
      the value of the html record component
    • title

      public String title()
      Returns the value of the title record component.
      Returns:
      the value of the title record component
    • previewText

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