andrew
/
Teaching_Assistant_Assistant
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added javadoc strings to Person.

This commit is contained in:
Andrew Lalis 2019-05-11 08:39:03 +02:00 committed by andrewlalis
parent dcc4dd0414
commit 28c7eaa261
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
src/main/java/nl/andrewlalis/teaching_assistant_assistant/model/people/Person.java
View File

@ -18,15 +18,27 @@ import java.util.List;
) )
public abstract class Person extends BasicEntity { public abstract class Person extends BasicEntity {
/**
* The person's first name.
*/
@Column(nullable = false) @Column(nullable = false)
private String firstName; private String firstName;
/**
* The person's last name.
*/
@Column(nullable = false) @Column(nullable = false)
private String lastName; private String lastName;
/**
* The person's email address.
*/
@Column @Column
private String emailAddress; private String emailAddress;
/**
* The person's github username.
*/
@Column @Column
private String githubUsername; private String githubUsername;
@ -74,12 +86,20 @@ public abstract class Person extends BasicEntity {
this.githubUsername = githubUsername; this.githubUsername = githubUsername;
} }
/**
* Assigns this person to a team.
* @param team The team to assign to.
*/
public void assignToTeam(Team team) { public void assignToTeam(Team team) {
if (!this.teams.contains(team)) { if (!this.teams.contains(team)) {
this.teams.add(team); this.teams.add(team);
} }
} }
/**
* Removes this person from a team.
* @param team The team to remove from.
*/
public void removeFromAssignedTeam(Team team) { public void removeFromAssignedTeam(Team team) {
this.teams.remove(team); this.teams.remove(team);
} }