Module qilletni.api

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

Record Class ParamDoc

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

Constructors

Constructor	Description
ParamDoc(String name, @Nullable DocFieldType docFieldType, @Nullable DocDescription description)	Creates an instance of a ParamDoc record class.

Method Summary

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

ParamDoc

public ParamDoc(String name,
 @Nullable
 @Nullable DocFieldType docFieldType,
 @Nullable
 @Nullable DocDescription description)

Creates an instance of a ParamDoc record class.

Parameters:

name - the value for the name record component

docFieldType - the value for the docFieldType record component

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

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

docFieldType

@Nullable
public @Nullable DocFieldType docFieldType()

Returns the value of the docFieldType record component.

Returns:

the value of the docFieldType record component

description

@Nullable
public @Nullable DocDescription description()

Returns the value of the description record component.

Returns:

the value of the description record component