Record Class RenderOptions

java.lang.Object
java.lang.Record
com.nsdev.lettergenerator.render.RenderOptions
Record Components:
debug - whether to draw declared layout rectangles over accepted PDF content
profile - requested native output profile

public record RenderOptions(boolean debug, OutputProfile profile) extends Record
Per-call PDF output choices and optional authoring overlays.
  • Constructor Details

    • RenderOptions

      public RenderOptions(boolean debug, OutputProfile profile)
      Requires an explicit profile; incompatible content is rejected before native rendering.
      Parameters:
      debug - authoring overlay flag
      profile - non-null native output profile
    • RenderOptions

      public RenderOptions(boolean debug)
      Preserves ordinary rendering and authoring previews through the original constructor.
      Parameters:
      debug - whether to draw declared layout rectangles
  • Method Details

    • defaults

      public static RenderOptions defaults()
      Returns:
      ordinary rendering without overlays or debug geometry
    • debugPreview

      public static RenderOptions debugPreview()
      Returns:
      rendering options that draw declared layout bounds for authoring previews
    • 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.
    • debug

      public boolean debug()
      Returns the value of the debug record component.
      Returns:
      the value of the debug record component
    • profile

      public OutputProfile profile()
      Returns the value of the profile record component.
      Returns:
      the value of the profile record component