Module qilletni.api

Package dev.qilletni.api.lang.docs.structure.text.inner

Record Class FieldDoc

java.lang.Object

java.lang.Record

dev.qilletni.api.lang.docs.structure.text.inner.FieldDoc

All Implemented Interfaces:

InnerDoc

public record FieldDoc(@Nullable DocDescription description, @Nullable DocFieldType fieldType)
extends Record
implements InnerDoc

Constructor Summary

Constructors

Constructor	Description
FieldDoc(@Nullable DocDescription description, @Nullable DocFieldType fieldType)	Creates an instance of a FieldDoc record class.

Method Summary

Modifier and Type	Method	Description
@Nullable DocDescription	description()	Returns the value of the description record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@Nullable DocFieldType	fieldType()	Returns the value of the fieldType record component.
final int	hashCode()	Returns a hash code value for this object.
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

FieldDoc

public FieldDoc(@Nullable
 @Nullable DocDescription description,
 @Nullable
 @Nullable DocFieldType fieldType)

Creates an instance of a FieldDoc record class.

Parameters:

description - the value for the description record component

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

description

@Nullable
public @Nullable DocDescription description()

Returns the value of the description record component.

Returns:

the value of the description record component

fieldType

@Nullable
public @Nullable DocFieldType fieldType()

Returns the value of the fieldType record component.

Returns:

the value of the fieldType record component