Module qilletni.api

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

Record Class FunctionDoc

java.lang.Object

java.lang.Record

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

All Implemented Interfaces:

InnerDoc

public record FunctionDoc(@Nullable DocDescription description, List<ParamDoc> paramDocs, @Nullable ReturnDoc returnDoc, @Nullable DocOnLine docOnLine, @Nullable DocErrors docErrors)
extends Record
implements InnerDoc

Constructor Summary

Constructors

Constructor	Description
FunctionDoc(@Nullable DocDescription description, List<ParamDoc> paramDocs, @Nullable ReturnDoc returnDoc, @Nullable DocOnLine docOnLine, @Nullable DocErrors docErrors)	Creates an instance of a FunctionDoc record class.

Method Summary

Modifier and Type	Method	Description
@Nullable DocDescription	description()	Returns the value of the description record component.
@Nullable DocErrors	docErrors()	Returns the value of the docErrors record component.
@Nullable DocOnLine	docOnLine()	Returns the value of the docOnLine 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.
List<ParamDoc>	paramDocs()	Returns the value of the paramDocs record component.
@Nullable ReturnDoc	returnDoc()	Returns the value of the returnDoc 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

FunctionDoc

public FunctionDoc(@Nullable
 @Nullable DocDescription description,
 List<ParamDoc> paramDocs,
 @Nullable
 @Nullable ReturnDoc returnDoc,
 @Nullable
 @Nullable DocOnLine docOnLine,
 @Nullable
 @Nullable DocErrors docErrors)

Creates an instance of a FunctionDoc record class.

Parameters:

description - the value for the description record component

paramDocs - the value for the paramDocs record component

returnDoc - the value for the returnDoc record component

docOnLine - the value for the docOnLine record component

docErrors - the value for the docErrors 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

paramDocs

public List<ParamDoc> paramDocs()

Returns the value of the paramDocs record component.

Returns:

the value of the paramDocs record component

returnDoc

@Nullable
public @Nullable ReturnDoc returnDoc()

Returns the value of the returnDoc record component.

Returns:

the value of the returnDoc record component

docOnLine

@Nullable
public @Nullable DocOnLine docOnLine()

Returns the value of the docOnLine record component.

Returns:

the value of the docOnLine record component

docErrors

@Nullable
public @Nullable DocErrors docErrors()

Returns the value of the docErrors record component.

Returns:

the value of the docErrors record component