Record Class ContentWarning

java.lang.Object
java.lang.Record
io.mindspice.simplypages.components.content.ContentWarning
public record ContentWarning(String sectionKey, Path sourcePath, String message) extends Record
Non-fatal parse or generation warning captured during content bundle generation. For generated detail/index collisions, sectionKey and sourcePath identify the detail's section and file. The message also identifies the index's section and directory, states detail precedence and pagination masking, and suggests choosing non-overlapping base paths or published slugs. Source paths are diagnostic context, not content intended for automatic public display.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ContentWarning(String sectionKey, Path sourcePath, String message)
    Creates an instance of a ContentWarning record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    message()
    Returns the value of the message record component.
    String
    sectionKey()
    Returns the value of the sectionKey record component.
    Path
    sourcePath()
    Returns the value of the sourcePath record component.
    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

    • ContentWarning

      public ContentWarning(String sectionKey, Path sourcePath, String message)
      Creates an instance of a ContentWarning record class.
      Parameters:
      sectionKey - the value for the sectionKey record component
      sourcePath - the value for the sourcePath record component
      message - the value for the message 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.

    • sectionKey

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

    • sourcePath

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

    • message

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