Module qilletni.api

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

Record Class DocumentedFile

java.lang.Object

java.lang.Record

dev.qilletni.api.lang.docs.structure.DocumentedFile

public record DocumentedFile(String fileName, Path importPath, List<DocumentedItem> documentedItems)
extends Record

Constructor Summary

Constructors

Constructor	Description
DocumentedFile(String fileName, Path importPath, List<DocumentedItem> documentedItems)	Creates an instance of a DocumentedFile record class.

Method Summary

Modifier and Type	Method	Description
List<DocumentedItem>	documentedItems()	Returns the value of the documentedItems record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	fileName()	Returns the value of the fileName record component.
final int	hashCode()	Returns a hash code value for this object.
Path	importPath()	Returns the value of the importPath 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

DocumentedFile

public DocumentedFile(String fileName,
 Path importPath,
 List<DocumentedItem> documentedItems)

Creates an instance of a DocumentedFile record class.

Parameters:

fileName - the value for the fileName record component

importPath - the value for the importPath record component

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

fileName

public String fileName()

Returns the value of the fileName record component.

Returns:

the value of the fileName record component

importPath

public Path importPath()

Returns the value of the importPath record component.

Returns:

the value of the importPath record component

documentedItems

public List<DocumentedItem> documentedItems()

Returns the value of the documentedItems record component.

Returns:

the value of the documentedItems record component