Package dev.siroshun.configapi.format.yaml.comment

Record Class YamlBlockComment

java.lang.Object
java.lang.Record
dev.siroshun.configapi.format.yaml.comment.YamlBlockComment
Record Components:
content - the content of the comment
prependBlankLines - the number of blank lines before the block comments
All Implemented Interfaces:
Comment, SimpleComment
public record YamlBlockComment(@NotNull String content, int prependBlankLines) extends Record implements SimpleComment
A SimpleComment implementation that holds the block comments in Yaml.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    TYPE
    The type of this comment.

  • Constructor Summary

    Constructors
    Constructor
    Description
    YamlBlockComment(@NotNull String content, int prependBlankLines)
    Creates an instance of a YamlBlockComment record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull String
    content()
    Returns the value of the content 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
    prependBlankLines()
    Returns the value of the prependBlankLines record component.
    final String
    toString()
    Returns a string representation of this record class.
    @NotNull String
    type()
    Returns the type of this comment.

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

    • YamlBlockComment

      public YamlBlockComment(@NotNull @NotNull String content, int prependBlankLines)
      Creates an instance of a YamlBlockComment record class.
      Parameters:
      content - the value for the content record component
      prependBlankLines - the value for the prependBlankLines record component

  • Method Details

    • type

      @NotNull public @NotNull String type()
      Description copied from interface: SimpleComment
      Returns the type of this comment.
      Specified by:
      type in interface SimpleComment
      Returns:
      the type of this comment

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

    • content

      @NotNull public @NotNull String content()
      Returns the value of the content record component.
      Specified by:
      content in interface SimpleComment
      Returns:
      the value of the content record component

    • prependBlankLines

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