java.lang.Object
java.lang.Record
dev.qilletni.api.lang.docs.structure.text.DocDescription
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interfaceA piece of a doc description.static final recordstatic final recordstatic final recordstatic final record -
Constructor Summary
ConstructorsConstructorDescriptionDocDescription(List<DocDescription.DescriptionItem> descriptionItems) Creates an instance of aDocDescriptionrecord class. -
Method Summary
Modifier and TypeMethodDescriptionReturns the value of thedescriptionItemsrecord component.final booleanIndicates whether some other object is "equal to" this one.final inthashCode()Returns a hash code value for this object.final StringtoString()Returns a string representation of this record class.
-
Constructor Details
-
DocDescription
Creates an instance of aDocDescriptionrecord class.- Parameters:
descriptionItems- the value for thedescriptionItemsrecord 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). -
descriptionItems
Returns the value of thedescriptionItemsrecord component.- Returns:
- the value of the
descriptionItemsrecord component
-