Record Class ToDo

java.lang.Object
java.lang.Record
com.ns.webserver.models.ToDo
Record Components:
id - The unique identifier for the ToDo item, generated using UUID.randomUUID(). This ID is used for referencing, updating, and deleting specific ToDo items. Must not be null.
title - The title or description of the ToDo task. This is the main textual content displayed to users describing what needs to be done. Should not be null or empty for meaningful tasks, though no validation is enforced at this level.
completed - A boolean flag indicating whether the ToDo item has been completed. true indicates the task is done, false indicates it is pending. This field supports task state tracking and filtering.
public record ToDo(UUID id, String title, boolean completed) extends Record
Immutable data model representing a ToDo item in the task management system.

This record encapsulates the essential attributes of a ToDo task, including a unique identifier, descriptive title, and completion status. As a Java record (introduced in Java 14), it provides automatic implementations of constructor, accessors, equals(), hashCode(), and toString() methods, ensuring immutability and value-based semantics.

Key characteristics:

  • Immutability: All fields are final; instances cannot be modified after creation
  • Value-based equality: Two ToDo instances are equal if all their fields are equal
  • Automatic accessors: id(), title(), and completed() methods are generated
  • Thread-safe: Immutability guarantees thread safety for read operations

Usage patterns: 

// Create a new ToDo item
UUID id = UUID.randomUUID();
ToDo todo = new ToDo(id, "Buy groceries", false);

// Access fields using generated accessors
String title = todo.title();        // "Buy groceries"
boolean done = todo.completed();    // false

// Create an updated version (immutable update pattern)
ToDo completedTodo = new ToDo(todo.id(), todo.title(), true);

JSON Representation: This record is typically serialized to JSON in the following format: 

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "title": "Buy groceries",
  "completed": false
}

Integration: This model is used by ToDoHandler to manage ToDo items through a RESTful API, with operations for creating, reading, updating, and deleting tasks.

Since:
1.0
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    ToDo(UUID id, String title, boolean completed)
    Creates an instance of a ToDo record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    completed()
    Returns the value of the completed record component.
    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.
    UUID
    id()
    Returns the value of the id record component.
    String
    title()
    Returns the value of the title 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

    • ToDo

      public ToDo(UUID id, String title, boolean completed)
      Creates an instance of a ToDo record class.
      Parameters:
      id - the value for the id record component
      title - the value for the title record component
      completed - the value for the completed 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      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 UUID id()
      Returns the value of the id record component.
      Returns:
      the value of the id record component

    • title

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

    • completed

      public boolean completed()
      Returns the value of the completed record component.
      Returns:
      the value of the completed record component