Record Class FrontmatterNavigation

java.lang.Object
java.lang.Record
guideme.compiler.FrontmatterNavigation
public record FrontmatterNavigation(String title, @Nullable net.minecraft.resources.Identifier parent, int position, @Nullable net.minecraft.resources.Identifier iconItemId, @Nullable Map<?,?> iconComponents) extends Record
Inserts a page into the navigation tree. Null parent means top-level category.

  • Constructor Summary

    Constructors
    Constructor
    Description
    FrontmatterNavigation(String title, @Nullable net.minecraft.resources.Identifier parent, int position, @Nullable net.minecraft.resources.Identifier iconItemId, @Nullable Map<?,?> iconComponents)
    Creates an instance of a FrontmatterNavigation 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.
    @Nullable Map<?,?>
    iconComponents()
    Returns the value of the iconComponents record component.
    @Nullable net.minecraft.resources.Identifier
    iconItemId()
    Returns the value of the iconItemId record component.
    @Nullable net.minecraft.resources.Identifier
    parent()
    Returns the value of the parent record component.
    int
    position()
    Returns the value of the position 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

    • FrontmatterNavigation

      public FrontmatterNavigation(String title, @Nullable @Nullable net.minecraft.resources.Identifier parent, int position, @Nullable @Nullable net.minecraft.resources.Identifier iconItemId, @Nullable @Nullable Map<?,?> iconComponents)
      Creates an instance of a FrontmatterNavigation record class.
      Parameters:
      title - the value for the title record component
      parent - the value for the parent record component
      position - the value for the position record component
      iconItemId - the value for the iconItemId record component
      iconComponents - the value for the iconComponents 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      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.

    • title

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

    • parent

      @Nullable public @Nullable net.minecraft.resources.Identifier parent()
      Returns the value of the parent record component.
      Returns:
      the value of the parent record component

    • position

      public int position()
      Returns the value of the position record component.
      Returns:
      the value of the position record component

    • iconItemId

      @Nullable public @Nullable net.minecraft.resources.Identifier iconItemId()
      Returns the value of the iconItemId record component.
      Returns:
      the value of the iconItemId record component

    • iconComponents

      @Nullable public @Nullable Map<?,?> iconComponents()
      Returns the value of the iconComponents record component.
      Returns:
      the value of the iconComponents record component