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 domain
domain - the topic domain the package's topics must carry as the prefix of their id
directory - the package directory
kind - what the package holds
files - every .adoc file 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 Details

    • Package

      public Package(String name, String domain, Path directory, PackageKind kind, List<TopicHeader> files)
      Creates an instance of a Package record class.
      Parameters:
      name - the value for the name record component
      domain - the value for the domain record component
      directory - the value for the directory record component
      kind - the value for the kind record component
      files - the value for the files record component
  • Method Details

    • topics

      public List<TopicHeader> topics()
      The files that declare a :topic-id:.
      Returns:
      the topics, in path order
    • 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.
    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component
    • domain

      public String domain()
      Returns the value of the domain record component.
      Returns:
      the value of the domain record component
    • directory

      public Path directory()
      Returns the value of the directory record component.
      Returns:
      the value of the directory record component
    • kind

      public PackageKind kind()
      Returns the value of the kind record component.
      Returns:
      the value of the kind record component
    • files

      public List<TopicHeader> files()
      Returns the value of the files record component.
      Returns:
      the value of the files record component