Record Class RosterStudentsController.PurgeDroppedResponse

java.lang.Object
java.lang.Record
edu.ucsb.cs156.frontiers.controllers.RosterStudentsController.PurgeDroppedResponse
Enclosing class:
RosterStudentsController

public static record RosterStudentsController.PurgeDroppedResponse(int deleted, int removedFromOrg, List<String> orgRemovalErrors) extends Record
Summary returned when purging all dropped roster students from a course.
  • Constructor Summary

    Constructors
    Constructor
    Description
    PurgeDroppedResponse(int deleted, int removedFromOrg, List<String> orgRemovalErrors)
    Creates an instance of a PurgeDroppedResponse record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    int
    Returns the value of the deleted record component.
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    Returns the value of the orgRemovalErrors record component.
    int
    Returns the value of the removedFromOrg record component.
    final String
    Returns a string representation of this record class.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • PurgeDroppedResponse

      public PurgeDroppedResponse(int deleted, int removedFromOrg, List<String> orgRemovalErrors)
      Creates an instance of a PurgeDroppedResponse record class.
      Parameters:
      deleted - the value for the deleted record component
      removedFromOrg - the value for the removedFromOrg record component
      orgRemovalErrors - the value for the orgRemovalErrors 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.
    • deleted

      public int deleted()
      Returns the value of the deleted record component.
      Returns:
      the value of the deleted record component
    • removedFromOrg

      public int removedFromOrg()
      Returns the value of the removedFromOrg record component.
      Returns:
      the value of the removedFromOrg record component
    • orgRemovalErrors

      public List<String> orgRemovalErrors()
      Returns the value of the orgRemovalErrors record component.
      Returns:
      the value of the orgRemovalErrors record component