Package com.io7m.cedarbridge.schema.ast

# Record Class CBASTDocumentation

java.lang.Object
java.lang.Record
com.io7m.cedarbridge.schema.ast.CBASTDocumentation

Record Components:
  `userData` - The mutable user data
  `lexical` - The lexical information
  `target` - The target element
  `text` - The text

All Implemented Interfaces:
  `CBASTDeclarationType`, `CBASTElementType`, `CBASTRecordMemberType`, `CBASTVariantMemberType`, `com.io7m.jlexing.core.LexicalType<URI>`

public record CBASTDocumentation(CBASTMutableUserData userData, com.io7m.jlexing.core.LexicalPosition<URI> lexical, String target, String text) extends Record implements CBASTVariantMemberType, CBASTRecordMemberType, CBASTDeclarationType
Documentation for an element.

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `CBASTDocumentation(CBASTMutableUserData userData, com.io7m.jlexing.core.LexicalPosition<URI> lexical, String target, String text)`
  Documentation for an element.

- ## 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.
  `com.io7m.jlexing.core.LexicalPosition<URI>`
  `lexical()`
  Returns the value of the `lexical` record component.
  `String`
  `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.
  `CBASTMutableUserData`
  `userData()`
  Returns the value of the `userData` record component.

  ### Methods inherited from class java.lang.Object

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

- ## Constructor Details

  - ### CBASTDocumentation

    public CBASTDocumentation(CBASTMutableUserData userData, com.io7m.jlexing.core.LexicalPosition<URI> lexical, String target, String text)
    Documentation for an element.
    Parameters:
      `userData` - The mutable user data
      `lexical` - The lexical information
      `target` - The target element
      `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.

  - ### userData

    public CBASTMutableUserData userData()
    Returns the value of the `userData` record component.
    Specified by:
      `userData` in interface `CBASTElementType`
    Returns:
      the value of the `userData` record component

  - ### lexical

    public com.io7m.jlexing.core.LexicalPosition<URI> lexical()
    Returns the value of the `lexical` record component.
    Specified by:
      `lexical` in interface `CBASTElementType`
    Specified by:
      `lexical` in interface `com.io7m.jlexing.core.LexicalType<URI>`
    Returns:
      the value of the `lexical` record component

  - ### target

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

  - ### text

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