Record Class StudentInfo

java.lang.Object
java.lang.Record
edu.ucsb.cs156.frontiers.models.StudentInfo
Record Components:
email - the student's email as stored on the roster
firstName - the shortest unique name for the student
legalFirstName - the roster's first name field, unchanged
lastName - the roster's last name field, unchanged
githubLogin - the student's GitHub login, or null if they have not linked GitHub yet
team - the name of the student's team (the first one, if they are on several), or null if they are not on a team
teams - the names of all the student's teams, possibly empty
teamMembers - everyone on team, including the student, or empty if the student has no team

public record StudentInfo(String email, String firstName, String legalFirstName, String lastName, String githubLogin, String team, List<String> teams, List<StudentInfo.Member> teamMembers) extends Record
What an autograder needs to know about one roster student: how to recognise them on GitHub, which team they are on, and who else is on that team. This is the response of GET /api/courses/studentInfo.

The firstName fields hold the shortest name that still identifies the student among all the (non-dropped) students of the course, as computed by TeamCsvService.nameAndTeams(List): e.g. "Chris" if there is only one Chris, "Chris L" if there are several. That is the name a teammate is likely to use for them. The legalFirstName fields hold the roster's first name field as is.

  • Constructor Details

    • StudentInfo

      public StudentInfo(String email, String firstName, String legalFirstName, String lastName, String githubLogin, String team, List<String> teams, List<StudentInfo.Member> teamMembers)
      Creates an instance of a StudentInfo record class.
      Parameters:
      email - the value for the email record component
      firstName - the value for the firstName record component
      legalFirstName - the value for the legalFirstName record component
      lastName - the value for the lastName record component
      githubLogin - the value for the githubLogin record component
      team - the value for the team record component
      teams - the value for the teams record component
      teamMembers - the value for the teamMembers 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. 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.
    • email

      public String email()
      Returns the value of the email record component.
      Returns:
      the value of the email record component
    • firstName

      public String firstName()
      Returns the value of the firstName record component.
      Returns:
      the value of the firstName record component
    • legalFirstName

      public String legalFirstName()
      Returns the value of the legalFirstName record component.
      Returns:
      the value of the legalFirstName record component
    • lastName

      public String lastName()
      Returns the value of the lastName record component.
      Returns:
      the value of the lastName record component
    • githubLogin

      public String githubLogin()
      Returns the value of the githubLogin record component.
      Returns:
      the value of the githubLogin record component
    • team

      public String team()
      Returns the value of the team record component.
      Returns:
      the value of the team record component
    • teams

      public List<String> teams()
      Returns the value of the teams record component.
      Returns:
      the value of the teams record component
    • teamMembers

      public List<StudentInfo.Member> teamMembers()
      Returns the value of the teamMembers record component.
      Returns:
      the value of the teamMembers record component