Record Class AdocPackages.Package
java.lang.Object
java.lang.Record
network.ike.docs.plugin.packages.AdocPackages.Package
- Record Components:
name- the package name,<group>/<domain>, or the group alone when the group directory is the domaindomain- the topic domain the package's topics must carry as the prefix of their iddirectory- the package directorykind- what the package holdsfiles- every.adocfile under the package, parsed, its path relative to the root, in path order
- Enclosing class:
AdocPackages
public static record AdocPackages.Package(String name, String domain, Path directory, PackageKind kind, List<TopicHeader> files)
extends Record
One package of a root.
- Since:
- 136
-
Constructor Summary
ConstructorsConstructorDescriptionPackage(String name, String domain, Path directory, PackageKind kind, List<TopicHeader> files) Creates an instance of aPackagerecord class. -
Method Summary
Modifier and TypeMethodDescriptionReturns the value of thedirectoryrecord component.domain()Returns the value of thedomainrecord component.final booleanIndicates whether some other object is "equal to" this one.files()Returns the value of thefilesrecord component.final inthashCode()Returns a hash code value for this object.kind()Returns the value of thekindrecord component.name()Returns the value of thenamerecord component.topics()The files that declare a:topic-id:.final StringtoString()Returns a string representation of this record class.
-
Constructor Details
-
Package
public Package(String name, String domain, Path directory, PackageKind kind, List<TopicHeader> files) Creates an instance of aPackagerecord class.
-
-
Method Details
-
topics
The files that declare a:topic-id:.- Returns:
- the topics, in path order
-
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). -
name
-
domain
-
directory
-
kind
-
files
-