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
ConstructorsConstructorDescriptionFieldDoc(@Nullable DocDescription description, @Nullable DocFieldType fieldType) Creates an instance of aFieldDocrecord class. -
Method Summary
Modifier and TypeMethodDescription@Nullable DocDescriptionReturns the value of thedescriptionrecord component.final booleanIndicates whether some other object is "equal to" this one.@Nullable DocFieldTypeReturns the value of thefieldTyperecord component.final inthashCode()Returns a hash code value for this object.final StringtoString()Returns a string representation of this record class.
-
Constructor Details
-
FieldDoc
public FieldDoc(@Nullable @Nullable DocDescription description, @Nullable @Nullable DocFieldType fieldType) Creates an instance of aFieldDocrecord class.- Parameters:
description- the value for thedescriptionrecord componentfieldType- the value for thefieldTyperecord component
-
-
Method Details
-
toString
-
hashCode
-
equals
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 withObjects::equals(Object,Object). -
description
Returns the value of thedescriptionrecord component.- Returns:
- the value of the
descriptionrecord component
-
fieldType
Returns the value of thefieldTyperecord component.- Returns:
- the value of the
fieldTyperecord component
-