Package com.github.siroshun09.configapi.format.yaml.comment

Record Class YamlNodeComment

java.lang.Object
java.lang.Record
com.github.siroshun09.configapi.format.yaml.comment.YamlNodeComment
Record Components:
block - the YamlBlockComment
inline - the YamlInlineComment
All Implemented Interfaces:
Comment
public record YamlNodeComment(@Nullable YamlBlockComment block, @Nullable YamlInlineComment inline) extends Record implements Comment
A Comment implementation that can have the YamlBlockComment and YamlInlineComment of the node.

  • Constructor Details

    • YamlNodeComment

      public YamlNodeComment(@Nullable @Nullable YamlBlockComment block, @Nullable @Nullable YamlInlineComment inline)
      Creates an instance of a YamlNodeComment record class.
      Parameters:
      block - the value for the block record component
      inline - the value for the inline 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.

    • block

      @Nullable public @Nullable YamlBlockComment block()
      Returns the value of the block record component.
      Returns:
      the value of the block record component

    • inline

      @Nullable public @Nullable YamlInlineComment inline()
      Returns the value of the inline record component.
      Returns:
      the value of the inline record component