Record Class GenerateDocs.Page

java.lang.Object
java.lang.Record
ai.redouble.docs.GenerateDocs.Page
Enclosing class:
GenerateDocs
public static record GenerateDocs.Page(String id, String title, Path source, String part, String origin) extends Record
One page of the site: its id (the file name without .html), its title from the contents, its markdown source, the part it belongs to as the breadcrumb reads it (null for the front matter) and the package and module the source documents (null for a document outside every module's source tree).
Since:
0.1 (2026-09-17)
Author:
Andrey Santrosyan

  • Constructor Summary

    Constructors
    Constructor
    Description
    Page(String id, String title, Path source, String part, String origin)
    Creates an instance of a Page record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    id()
    Returns the value of the id record component.
    String
    origin()
    Returns the value of the origin record component.
    String
    part()
    Returns the value of the part record component.
    Path
    source()
    Returns the value of the source record component.
    String
    title()
    Returns the value of the title record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Page

      public Page(String id, String title, Path source, String part, String origin)
      Creates an instance of a Page record class.
      Parameters:
      id - the value for the id record component
      title - the value for the title record component
      source - the value for the source record component
      part - the value for the part record component
      origin - the value for the origin 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.

    • id

      public String id()
      Returns the value of the id record component.
      Returns:
      the value of the id record component

    • title

      public String title()
      Returns the value of the title record component.
      Returns:
      the value of the title record component

    • source

      public Path source()
      Returns the value of the source record component.
      Returns:
      the value of the source record component

    • part

      public String part()
      Returns the value of the part record component.
      Returns:
      the value of the part record component

    • origin

      public String origin()
      Returns the value of the origin record component.
      Returns:
      the value of the origin record component