Record Class MjmlDocument

java.lang.Object
java.lang.Record
dev.jcputney.mjml.parser.MjmlDocument
Record Components:
root - the root <mjml> node of the document
public record MjmlDocument(MjmlNode root) extends Record
Represents an MJML document's structure, containing a root node and methods to access key elements such as the head and body nodes. This class encapsulates the MJML document's logical model, allowing for the retrieval of specific parts of its structure.

  • Constructor Summary

    Constructors
    Constructor
    Description
    MjmlDocument(MjmlNode root)
    Creates an instance of a MjmlDocument record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    MjmlNode
    getBody()
    Returns the mj-body node, or null if not present.
    MjmlNode
    getHead()
    Returns the mj-head node, or null if not present.
    final int
    hashCode()
    Returns a hash code value for this object.
    MjmlNode
    root()
    Returns the root node of this document.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • MjmlDocument

      public MjmlDocument(MjmlNode root)
      Creates an instance of a MjmlDocument record class.
      Parameters:
      root - the value for the root record component

  • Method Details

    • root

      public MjmlNode root()
      Returns the root node of this document.
      Returns:
      the root <mjml> node

    • getHead

      public MjmlNode getHead()
      Returns the mj-head node, or null if not present.
      Returns:
      the <mj-head> node, or null

    • getBody

      public MjmlNode getBody()
      Returns the mj-body node, or null if not present.
      Returns:
      the <mj-body> node, or null

    • 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.