Module qilletni.api

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

Record Class EntityDoc

java.lang.Object

java.lang.Record

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

Record Components:

description - The description of the actual entity definition

containedItems - Fields, functions, constructors, etc. of the entity

onExtensionFunctions - Functions that are added onto the entity from an 'on' extension from either the current library or an external one

All Implemented Interfaces:

InnerDoc

public record EntityDoc(@Nullable DocDescription description, List<DocumentedItem> containedItems, List<DocumentedItem> onExtensionFunctions)
extends Record
implements InnerDoc

Constructor Summary

Constructors

Constructor	Description
EntityDoc(@Nullable DocDescription description)
EntityDoc(@Nullable DocDescription description, List<DocumentedItem> containedItems, List<DocumentedItem> onExtensionFunctions)	Creates an instance of a EntityDoc record class.

Method Summary

Modifier and Type	Method	Description
void	addDocItem(DocumentedItem documentedItem)
void	addOnExtension(DocumentedItem documentedItem)
List<DocumentedItem>	containedItems()	Returns the value of the containedItems record component.
@Nullable DocDescription	description()	Returns the value of the description 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<DocumentedItem>	onExtensionFunctions()	Returns the value of the onExtensionFunctions 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

EntityDoc

public EntityDoc(@Nullable
 @Nullable DocDescription description)

EntityDoc

public EntityDoc(@Nullable
 @Nullable DocDescription description,
 List<DocumentedItem> containedItems,
 List<DocumentedItem> onExtensionFunctions)

Creates an instance of a EntityDoc record class.

Parameters:

description - the value for the description record component

containedItems - the value for the containedItems record component

onExtensionFunctions - the value for the onExtensionFunctions record component

Method Details

addDocItem

public void addDocItem(DocumentedItem documentedItem)

addOnExtension

public void addOnExtension(DocumentedItem documentedItem)

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

containedItems

public List<DocumentedItem> containedItems()

Returns the value of the containedItems record component.

Returns:

the value of the containedItems record component

onExtensionFunctions

public List<DocumentedItem> onExtensionFunctions()

Returns the value of the onExtensionFunctions record component.

Returns:

the value of the onExtensionFunctions record component