Module qilletni.api

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

Record Class DocDescription

java.lang.Object

java.lang.Record

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

public record DocDescription(List<DocDescription.DescriptionItem> descriptionItems)
extends Record

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DocDescription.DescriptionItem	A piece of a doc description.
static final record	DocDescription.DocText
static final record	DocDescription.JavaRef
static final record	DocDescription.ParamRef
static final record	DocDescription.TypeRef

Constructor Summary

Constructors

Constructor	Description
DocDescription(List<DocDescription.DescriptionItem> descriptionItems)	Creates an instance of a DocDescription record class.

Method Summary

Modifier and Type	Method	Description
List<DocDescription.DescriptionItem>	descriptionItems()	Returns the value of the descriptionItems 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.
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

DocDescription

public DocDescription(List<DocDescription.DescriptionItem> descriptionItems)

Creates an instance of a DocDescription record class.

Parameters:

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

descriptionItems

public List<DocDescription.DescriptionItem> descriptionItems()

Returns the value of the descriptionItems record component.

Returns:

the value of the descriptionItems record component