# Record Class CATypeRecordDeclaration

java.lang.Object
java.lang.Record
com.io7m.cardant.model.type_package.CATypeRecordDeclaration

Record Components:
  `name` - The type name
  `description` - The description
  `fields` - The fields

public record CATypeRecordDeclaration(CANameUnqualified name, String description, Map<CANameUnqualified, CATypeFieldDeclaration> fields) extends Record
A declaration for a record type.

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `CATypeRecordDeclaration(CANameUnqualified name, String description, Map<CANameUnqualified, CATypeFieldDeclaration> fields)`
  A declaration for a record type.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `String`
  `description()`
  Returns the value of the `description` record component.
  `final boolean`
  `equals(Object o)`
  Indicates whether some other object is "equal to" this one.
  `Map<CANameUnqualified, CATypeFieldDeclaration>`
  `fields()`
  Returns the value of the `fields` record component.
  `final int`
  `hashCode()`
  Returns a hash code value for this object.
  `CANameUnqualified`
  `name()`
  Returns the value of the `name` 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

  - ### CATypeRecordDeclaration

    public CATypeRecordDeclaration(CANameUnqualified name, String description, Map<CANameUnqualified, CATypeFieldDeclaration> fields)
    A declaration for a record type.
    Parameters:
      `name` - The type name
      `description` - The description
      `fields` - The fields

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

  - ### name

    public CANameUnqualified name()
    Returns the value of the `name` record component.
    Returns:
      the value of the `name` record component

  - ### description

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

  - ### fields

    public Map<CANameUnqualified, CATypeFieldDeclaration> fields()
    Returns the value of the `fields` record component.
    Returns:
      the value of the `fields` record component