java.lang.Object
java.lang.Record
dev.qilletni.api.lang.docs.structure.text.ParamDoc
public record ParamDoc(String name, @Nullable DocFieldType docFieldType, @Nullable DocDescription description)
extends Record
-
Constructor Summary
ConstructorsConstructorDescriptionParamDoc(String name, @Nullable DocFieldType docFieldType, @Nullable DocDescription description) Creates an instance of aParamDocrecord class. -
Method Summary
Modifier and TypeMethodDescription@Nullable DocDescriptionReturns the value of thedescriptionrecord component.@Nullable DocFieldTypeReturns the value of thedocFieldTyperecord component.final booleanIndicates whether some other object is "equal to" this one.final inthashCode()Returns a hash code value for this object.name()Returns the value of thenamerecord component.final StringtoString()Returns a string representation of this record class.
-
Constructor Details
-
ParamDoc
public ParamDoc(String name, @Nullable @Nullable DocFieldType docFieldType, @Nullable @Nullable DocDescription description) Creates an instance of aParamDocrecord class.- Parameters:
name- the value for thenamerecord componentdocFieldType- the value for thedocFieldTyperecord componentdescription- the value for thedescriptionrecord 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). -
name
Returns the value of thenamerecord component.- Returns:
- the value of the
namerecord component
-
docFieldType
Returns the value of thedocFieldTyperecord component.- Returns:
- the value of the
docFieldTyperecord component
-
description
Returns the value of thedescriptionrecord component.- Returns:
- the value of the
descriptionrecord component
-