Record Class RosterStudentsController.OrgRemovalResult

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

public static record RosterStudentsController.OrgRemovalResult(boolean attempted, boolean successful, String errorMessage) extends Record
Outcome of the optional GitHub organization removal step when deleting a roster student.
  • Constructor Summary

    Constructors
    Constructor
    Description
    OrgRemovalResult(boolean attempted, boolean successful, String errorMessage)
    Creates an instance of a OrgRemovalResult record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    Returns the value of the attempted record component.
    final boolean
    Indicates whether some other object is "equal to" this one.
    Returns the value of the errorMessage record component.
    final int
    Returns a hash code value for this object.
    boolean
    Returns the value of the successful 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

    • OrgRemovalResult

      public OrgRemovalResult(boolean attempted, boolean successful, String errorMessage)
      Creates an instance of a OrgRemovalResult record class.
      Parameters:
      attempted - the value for the attempted record component
      successful - the value for the successful record component
      errorMessage - the value for the errorMessage 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.
    • attempted

      public boolean attempted()
      Returns the value of the attempted record component.
      Returns:
      the value of the attempted record component
    • successful

      public boolean successful()
      Returns the value of the successful record component.
      Returns:
      the value of the successful record component
    • errorMessage

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