# Record Class CALocationSummary

java.lang.Object
java.lang.Record
com.io7m.cardant.model.CALocationSummary

Record Components:
  `id` - The id
  `parent` - The parent
  `path` - The location path
  `timeCreated` - The time the item was created
  `timeUpdated` - The time the item was last updated

public record CALocationSummary(CALocationID id, Optional<CALocationID> parent, CALocationPath path, OffsetDateTime timeCreated, OffsetDateTime timeUpdated) extends Record
A summary of a location.

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `CALocationSummary(CALocationID id, Optional<CALocationID> parent, CALocationPath path, OffsetDateTime timeCreated, OffsetDateTime timeUpdated)`
  A summary of a location.

- ## 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.
  `CALocationID`
  `id()`
  Returns the value of the `id` record component.
  `CALocationName`
  `name()`
  `Optional<CALocationID>`
  `parent()`
  Returns the value of the `parent` record component.
  `CALocationPath`
  `path()`
  Returns the value of the `path` record component.
  `OffsetDateTime`
  `timeCreated()`
  Returns the value of the `timeCreated` record component.
  `OffsetDateTime`
  `timeUpdated()`
  Returns the value of the `timeUpdated` record component.
  `final String`
  `toString()`
  Returns a string representation of this record class.
  `CALocationSummary`
  `withPath(CALocationPath newPath)`
  Adjust this location summary to have a new path.

  ### Methods inherited from class Object

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

- ## Constructor Details

  - ### CALocationSummary

    public CALocationSummary(CALocationID id, Optional<CALocationID> parent, CALocationPath path, OffsetDateTime timeCreated, OffsetDateTime timeUpdated)
    A summary of a location.
    Parameters:
      `id` - The id
      `parent` - The parent
      `path` - The location path
      `timeCreated` - The time the item was created
      `timeUpdated` - The time the item was last updated

- ## Method Details

  - ### name

    public CALocationName name()
    Returns:
      The location name (the last path component)

  - ### withPath

    public CALocationSummary withPath(CALocationPath newPath)
    Adjust this location summary to have a new path.
    Parameters:
      `newPath` - The new path
    Returns:
      This location summary with a new path

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

  - ### id

    public CALocationID id()
    Returns the value of the `id` record component.
    Returns:
      the value of the `id` record component

  - ### parent

    public Optional<CALocationID> parent()
    Returns the value of the `parent` record component.
    Returns:
      the value of the `parent` record component

  - ### path

    public CALocationPath path()
    Returns the value of the `path` record component.
    Returns:
      the value of the `path` record component

  - ### timeCreated

    public OffsetDateTime timeCreated()
    Returns the value of the `timeCreated` record component.
    Returns:
      the value of the `timeCreated` record component

  - ### timeUpdated

    public OffsetDateTime timeUpdated()
    Returns the value of the `timeUpdated` record component.
    Returns:
      the value of the `timeUpdated` record component