Record Class TopicRegistry.Scan

java.lang.Object
java.lang.Record
network.ike.docs.plugin.registry.TopicRegistry.Scan
Record Components:
root - the root that was scanned
topics - the files that declare a :topic-id:, in path order
others - the files that do not, in path order
findings - every finding, each prefixed with the file it concerns
Enclosing class:
TopicRegistry

public static record TopicRegistry.Scan(Path root, List<TopicHeader> topics, List<TopicHeader> others, List<String> findings) extends Record
One scan root's result.
Since:
109
  • Constructor Details

    • Scan

      public Scan(Path root, List<TopicHeader> topics, List<TopicHeader> others, List<String> findings)
      Creates an instance of a Scan record class.
      Parameters:
      root - the value for the root record component
      topics - the value for the topics record component
      others - the value for the others record component
      findings - the value for the findings 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.
    • root

      public Path root()
      Returns the value of the root record component.
      Returns:
      the value of the root record component
    • topics

      public List<TopicHeader> topics()
      Returns the value of the topics record component.
      Returns:
      the value of the topics record component
    • others

      public List<TopicHeader> others()
      Returns the value of the others record component.
      Returns:
      the value of the others record component
    • findings

      public List<String> findings()
      Returns the value of the findings record component.
      Returns:
      the value of the findings record component