Module qilletni.api

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

Record Class DocumentedItem

java.lang.Object

java.lang.Record

dev.qilletni.api.lang.docs.structure.DocumentedItem

Record Components:

itemBeingDocumented - The item actually being documented

innerDoc - The structured text of the doc string

public record DocumentedItem(DocumentedType itemBeingDocumented, InnerDoc innerDoc)
extends Record

Constructor Summary

Constructors

Constructor	Description
DocumentedItem(DocumentedType itemBeingDocumented, InnerDoc innerDoc)	Creates an instance of a DocumentedItem record class.

Method Summary

Modifier and Type	Method	Description
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.
InnerDoc	innerDoc()	Returns the value of the innerDoc record component.
DocumentedType	itemBeingDocumented()	Returns the value of the itemBeingDocumented 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

DocumentedItem

public DocumentedItem(DocumentedType itemBeingDocumented,
 InnerDoc innerDoc)

Creates an instance of a DocumentedItem record class.

Parameters:

itemBeingDocumented - the value for the itemBeingDocumented record component

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

itemBeingDocumented

public DocumentedType itemBeingDocumented()

Returns the value of the itemBeingDocumented record component.

Returns:

the value of the itemBeingDocumented record component

innerDoc

public InnerDoc innerDoc()

Returns the value of the innerDoc record component.

Returns:

the value of the innerDoc record component