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
ConstructorsConstructorDescriptionDocumentedFile(String fileName, Path importPath, List<DocumentedItem> documentedItems) Creates an instance of aDocumentedFilerecord class. -
Method Summary
Modifier and TypeMethodDescriptionReturns the value of thedocumentedItemsrecord component.final booleanIndicates whether some other object is "equal to" this one.fileName()Returns the value of thefileNamerecord component.final inthashCode()Returns a hash code value for this object.Returns the value of theimportPathrecord component.final StringtoString()Returns a string representation of this record class.
-
Constructor Details
-
DocumentedFile
Creates an instance of aDocumentedFilerecord class.- Parameters:
fileName- the value for thefileNamerecord componentimportPath- the value for theimportPathrecord componentdocumentedItems- the value for thedocumentedItemsrecord component
-
-
Method Details
-
toString
-
hashCode
-
equals
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 withObjects::equals(Object,Object). -
fileName
Returns the value of thefileNamerecord component.- Returns:
- the value of the
fileNamerecord component
-
importPath
Returns the value of theimportPathrecord component.- Returns:
- the value of the
importPathrecord component
-
documentedItems
Returns the value of thedocumentedItemsrecord component.- Returns:
- the value of the
documentedItemsrecord component
-