Package org.pkl.core

Record Class Release.Documentation

java.lang.Object
java.lang.Record
org.pkl.core.Release.Documentation
Record Components:
homepage - the homepage of this documentation
Enclosing class:
Release

public static record Release.Documentation(String homepage) extends Record
The documentation of a Pkl release.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Creates an instance of a Documentation record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    Returns the value of the homepage record component.
    final String
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • Documentation

      public Documentation(String homepage)
      Creates an instance of a Documentation record class.
      Parameters:
      homepage - the value for the homepage 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.
    • homepage

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