Record Class CommentBlock

java.lang.Object
java.lang.Record
pro.verron.asciidoc.core.CommentBlock
Record Components:
comment - the text of the comment line
All Implemented Interfaces:
Block
public record CommentBlock(String comment) extends Record implements Block

Represents a comment line in the AsciiDoc document model.

A comment line is a block-level element that does not contribute visible content. Its size is always zero.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CommentBlock(String comment)
    Creates an instance of a CommentBlock record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    comment()
    Returns the value of the comment record component.
    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.
    int
    size()
    Returns the content size of this block.
    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

    • CommentBlock

      public CommentBlock(String comment)
      Creates an instance of a CommentBlock record class.
      Parameters:
      comment - the value for the comment record component

  • Method Details

    • size

      public int size()
      Description copied from interface: Block
      Returns the content size of this block.
      Specified by:
      size in interface Block
      Returns:
      the number of content units in this block

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

    • comment

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