Package com.io7m.aradine.instrument.spi1.xml.internal

Record Class ARI1Link

java.lang.Object
java.lang.Record
com.io7m.aradine.instrument.spi1.xml.internal.ARI1Link
Record Components:
target - The link target
text - The text
All Implemented Interfaces:
ARI1LinkType, ARI1ParagraphContentType
public record ARI1Link(URI target, String text) extends Record implements ARI1LinkType
A link element within documentation.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ARI1Link(URI target, String text)
    A link element within documentation.

  • 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.
    URI
    target()
    Returns the value of the target record component.
    String
    text()
    Returns the value of the text record component.
    final String
    toString()
    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

    • ARI1Link

      public ARI1Link(URI target, String text)
      A link element within documentation.
      Parameters:
      target - The link target
      text - The text

  • 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.

    • target

      public URI target()
      Returns the value of the target record component.
      Specified by:
      target in interface ARI1LinkType
      Returns:
      the value of the target record component

    • text

      public String text()
      Returns the value of the text record component.
      Specified by:
      text in interface ARI1LinkType
      Returns:
      the value of the text record component