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

Record Class YamlRootComment

java.lang.Object

java.lang.Record

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

Record Components:

header - the YamlBlockComment

footer - the YamlBlockComment

All Implemented Interfaces:

Comment

public record YamlRootComment(@Nullable YamlBlockComment header, @Nullable YamlBlockComment footer)
extends Record
implements Comment

A Comment implementation that can have the header and footer of the root node.

Constructor Summary

Constructors

Constructor	Description
YamlRootComment(@Nullable YamlBlockComment header, @Nullable YamlBlockComment footer)	Creates an instance of a YamlRootComment record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@Nullable YamlBlockComment	footer()	Returns the value of the footer record component.
final int	hashCode()	Returns a hash code value for this object.
@Nullable YamlBlockComment	header()	Returns the value of the header record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

YamlRootComment

public YamlRootComment(@Nullable
 @Nullable YamlBlockComment header,
 @Nullable
 @Nullable YamlBlockComment footer)

Creates an instance of a YamlRootComment record class.

Parameters:

header - the value for the header record component

footer - the value for the footer 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.

header

@Nullable
public @Nullable YamlBlockComment header()

Returns the value of the header record component.

Returns:

the value of the header record component

footer

@Nullable
public @Nullable YamlBlockComment footer()

Returns the value of the footer record component.

Returns:

the value of the footer record component