Record Class Comment

java.lang.Object
java.lang.Record
pro.verron.asciidoc.core.Comment
Record Components:
id - unique identifier for the comment
blockStart - starting block position
lineStart - starting line position
blockEnd - ending block position
lineEnd - ending line position

public record Comment(BigInteger id, int blockStart, int lineStart, int blockEnd, int lineEnd) extends Record
Represents a comment with positional information.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Comment(BigInteger id, int blockStart, int lineStart, int blockEnd, int lineEnd)
    Creates an instance of a Comment record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    int
    Returns the value of the blockEnd record component.
    int
    Returns the value of the blockStart record component.
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    id()
    Returns the value of the id record component.
    int
    Returns the value of the lineEnd record component.
    int
    Returns the value of the lineStart record component.
    final String
    Returns a string representation of this record class.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • Comment

      public Comment(BigInteger id, int blockStart, int lineStart, int blockEnd, int lineEnd)
      Creates an instance of a Comment record class.
      Parameters:
      id - the value for the id record component
      blockStart - the value for the blockStart record component
      lineStart - the value for the lineStart record component
      blockEnd - the value for the blockEnd record component
      lineEnd - the value for the lineEnd 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      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.
    • id

      public BigInteger id()
      Returns the value of the id record component.
      Returns:
      the value of the id record component
    • blockStart

      public int blockStart()
      Returns the value of the blockStart record component.
      Returns:
      the value of the blockStart record component
    • lineStart

      public int lineStart()
      Returns the value of the lineStart record component.
      Returns:
      the value of the lineStart record component
    • blockEnd

      public int blockEnd()
      Returns the value of the blockEnd record component.
      Returns:
      the value of the blockEnd record component
    • lineEnd

      public int lineEnd()
      Returns the value of the lineEnd record component.
      Returns:
      the value of the lineEnd record component