Module page.codeberg.friedolyn.Friedolyn

Package page.codeberg.friedolyn.grades

Class GradesTable

java.lang.Object

page.codeberg.friedolyn.grades.GradesTable

public class GradesTable
extends Object

Represents the exhaustive list of the student's grades, including all courses, modules and exams with their respective grades.

Field Summary

Fields

Modifier and Type	Field	Description
private final @NonNull ArrayList<Account>	ACCOUNTS	The accounts that are part of this grades table but not of any courses.
private final @NonNull ArrayList<Course>	COURSES	The courses that the student is enrolled in and whose grades are listed in this table.
private final @NonNull ArrayList<Module>	MODULES	The modules that are part of this grade table but not of any courses.
private PersonalInformation	personalInformation	Personal data of the student that are included in the grades table.
private final @NonNull ArrayList<Subaccount>	SUBACCOUNTS	The subaccounts that are part of this grades table (but not of any courses or accounts) and may contain their own modules.

Constructor Summary

Constructors

Constructor	Description
GradesTable()

Method Summary

Modifier and Type	Method	Description
void	addAccount(@NonNull Account account)	Inserts a new Account at the end of this course's accounts list.
void	addAccounts(@NonNull Account... accounts)	Inserts the specified Accounts at the end of this course's accounts list.
void	addCourse(@NonNull Course course)	Inserts the specified Course at the end of this grade table's courses list.
void	addCourses(@NonNull Course... courses)	Inserts the specified Courses at the end of this grade table's courses list.
void	addModule(@NonNull Module module)	Adds a Module to the end of this grade table's modules list.
void	addModules(@NonNull Module... modules)	Adds the specified Modules to the end of this grade table's modules list.
void	addSubaccount(@NonNull Subaccount subaccount)	Inserts the specified Subaccount at the end of this account's subaccounts list.
void	addSubaccounts(@NonNull Subaccount... subaccounts)	Inserts the specified Subaccounts at the end of this account's subaccounts list, in the given order.
void	clearAccounts()	Removes all accounts from this course's accounts list.
void	clearCourses()	Removes all courses from this grade table's courses list.
void	clearModules()	Removes all modules from this grade table's modules list.
void	clearSubaccounts()	Removes all subaccounts from this account's subaccounts list.
boolean	equals(Object object)	Checks whether this GradesTable's fields are equal to their counterparts in the specified object (if it is a GradesTable at all).
@NonNull ArrayList<Account>	getAccounts()
@NonNull ArrayList<Course>	getCourses()
@NonNull ArrayList<Module>	getOrphanModules()
@NonNull Optional<PersonalInformation>	getPersonalInformation()
@NonNull ArrayList<Subaccount>	getSubaccounts()
@NonNull Account	removeAccount(int index)	Removes the account at the specified position in this course's accounts list.
boolean	removeAccount(@NonNull Account account)	Removes the first occurrence of the specified Account from this course's accounts list, if it is present.
@NonNull ArrayList<Account>	removeAccounts(int... indices)	Removes the accounts at the specified positions in this course's accounts list.
boolean	removeAccounts(@NonNull Account... accounts)	Removes the specified Accounts from this course's accounts list, if they are present.
@NonNull Course	removeCourse(int index)	Removes the course at the specified position in this grade table's courses list.
boolean	removeCourse(@NonNull Course course)	Removes the first occurrence of the specified Course from this grade table's courses list, if it is present.
@NonNull ArrayList<Course>	removeCourses(int... indices)	Removes the courses at the specified positions in this grade table's courses list.
boolean	removeCourses(@NonNull Course... courses)	Removes the specified Courses from this grade table's courses list, if they are present.
@NonNull Module	removeModule(int index)	Removes the module at the specified position in this grade table's modules list.
boolean	removeModule(@NonNull Module module)	Removes the first occurrence of the specified Module from this grade table's modules list, if it is present.
@NonNull ArrayList<Module>	removeModules(int... indices)	Removes the modules at the specified positions in this grade table's modules list.
boolean	removeModules(@NonNull Module... modules)	Removes the specified Modules from this grade table's modules list, if they are present.
@NonNull Subaccount	removeSubaccount(int index)	Removes the subaccount at the specified position in this account's subaccounts list.
boolean	removeSubaccount(@NonNull Subaccount subaccount)	Removes the first occurrence of the specified Subaccount from this account's subaccounts list, if it is present.
@NonNull ArrayList<Subaccount>	removeSubaccounts(int... indices)	Removes the subaccounts at the specified positions in this account's subaccounts list.
boolean	removeSubaccounts(@NonNull Subaccount... subaccounts)	Removes the specified Subaccounts from this account's subaccounts list, if they are present.
void	saveTo(@NonNull File file)	Writes this GradesTable to the specified file in JSON format.
void	setPersonalInformation(@NonNull PersonalInformation personalInformation)	Updates the personal data of the student that are included in the grades table.
@NonNull String	toJSON()	Converts this GradesTable to a JSON string with all fields.
@NonNull String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

personalInformation

@Nullable
private PersonalInformation personalInformation

Personal data of the student that are included in the grades table.

COURSES

@NonNull
private final @NonNull ArrayList<Course> COURSES

The courses that the student is enrolled in and whose grades are listed in this table.

ACCOUNTS

@NonNull
private final @NonNull ArrayList<Account> ACCOUNTS

The accounts that are part of this grades table but not of any courses. May contain their own modules.

SUBACCOUNTS

@NonNull
private final @NonNull ArrayList<Subaccount> SUBACCOUNTS

The subaccounts that are part of this grades table (but not of any courses or accounts) and may contain their own modules.

MODULES

@NonNull
private final @NonNull ArrayList<Module> MODULES

The modules that are part of this grade table but not of any courses.

Constructor Details

GradesTable

public GradesTable()

Method Details

getPersonalInformation

@NonNull
public @NonNull Optional<PersonalInformation> getPersonalInformation()

Returns:

The personal data of the student that are included in the grades table.

getCourses

@NonNull
public @NonNull ArrayList<Course> getCourses()

Returns:

The courses that the student is enrolled in and whose grades are listed in this table.

getAccounts

@NonNull
public @NonNull ArrayList<Account> getAccounts()

Returns:

The accounts that are part of this grades table but not of any courses. May contain their own modules.

getSubaccounts

@NonNull
public @NonNull ArrayList<Subaccount> getSubaccounts()

Returns:

The subaccounts that are part of this grades table (but not of any courses or accounts) and may contain their own modules.

getOrphanModules

@NonNull
public @NonNull ArrayList<Module> getOrphanModules()

Returns:

The modules that are part of this grade table but not of any courses, accounts or subaccounts.

setPersonalInformation

public void setPersonalInformation(@NonNull
 @NonNull PersonalInformation personalInformation)

Updates the personal data of the student that are included in the grades table.

Parameters:

personalInformation - The student's personal data.

addCourse

public void addCourse(@NonNull
 @NonNull Course course)

Inserts the specified Course at the end of this grade table's courses list.

addCourses

public void addCourses(@NonNull
 @NonNull Course... courses)

Inserts the specified Courses at the end of this grade table's courses list.

removeCourse

public boolean removeCourse(@NonNull
 @NonNull Course course)

Removes the first occurrence of the specified Course from this grade table's courses list, if it is present.

Parameters:

course - The course to remove.

Returns:

true if this list contained the specified element, false otherwise.

removeCourses

public boolean removeCourses(@NonNull
 @NonNull Course... courses)

Removes the specified Courses from this grade table's courses list, if they are present.

Parameters:

courses - The courses to remove.

Returns:

true if this list was modified as a result of this operation.

removeCourse

@NonNull
public @NonNull Course removeCourse(int index)
                             throws IndexOutOfBoundsException

Removes the course at the specified position in this grade table's courses list.

Parameters:

index - The index of the course to remove. Must be between 0 (inclusive) and the size of the list (exclusive).

Returns:

The course previously at the specified position.

Throws:

IndexOutOfBoundsException - If the index is out of range.

removeCourses

@NonNull
public @NonNull ArrayList<Course> removeCourses(int... indices)
                                         throws IndexOutOfBoundsException

Removes the courses at the specified positions in this grade table's courses list.

Parameters:

indices - The indices of the courses to remove. Must be between 0 (inclusive) and the size of the list (exclusive).

Returns:

The courses previously at the specified positions.

Throws:

IndexOutOfBoundsException - If any of the indices are out of range.

clearCourses

public void clearCourses()

Removes all courses from this grade table's courses list.

addAccount

public void addAccount(@NonNull
 @NonNull Account account)

Inserts a new Account at the end of this course's accounts list.

Parameters:

account - The account to add.

addAccounts

public void addAccounts(@NonNull
 @NonNull Account... accounts)

Inserts the specified Accounts at the end of this course's accounts list.

Parameters:

accounts - The accounts to add.

removeAccount

public boolean removeAccount(@NonNull
 @NonNull Account account)

Removes the first occurrence of the specified Account from this course's accounts list, if it is present.

Parameters:

account - The account to remove.

Returns:

true if this list contained the specified element, false otherwise.

removeAccounts

public boolean removeAccounts(@NonNull
 @NonNull Account... accounts)

Removes the specified Accounts from this course's accounts list, if they are present.

Parameters:

accounts - The accounts to remove.

Returns:

true if this list was modified as a result of this operation.

removeAccount

@NonNull
public @NonNull Account removeAccount(int index)
                               throws IndexOutOfBoundsException

Removes the account at the specified position in this course's accounts list.

Parameters:

index - The index of the account to remove. Must be between 0 (inclusive) and the size of the list (exclusive).

Returns:

The account previously at the specified position.

Throws:

IndexOutOfBoundsException - If the index is out of range.

removeAccounts

@NonNull
public @NonNull ArrayList<Account> removeAccounts(int... indices)
                                           throws IndexOutOfBoundsException

Removes the accounts at the specified positions in this course's accounts list.

Parameters:

indices - The indices of the accounts to remove. Must be between 0 (inclusive) and the size of the list (exclusive).

Returns:

The accounts previously at the specified positions.

Throws:

IndexOutOfBoundsException - If any of the indices are out of range.

clearAccounts

public void clearAccounts()

Removes all accounts from this course's accounts list.

addSubaccount

public void addSubaccount(@NonNull
 @NonNull Subaccount subaccount)

Inserts the specified Subaccount at the end of this account's subaccounts list.

addSubaccounts

public void addSubaccounts(@NonNull
 @NonNull Subaccount... subaccounts)

Inserts the specified Subaccounts at the end of this account's subaccounts list, in the given order.

removeSubaccount

public boolean removeSubaccount(@NonNull
 @NonNull Subaccount subaccount)

Removes the first occurrence of the specified Subaccount from this account's subaccounts list, if it is present.

Parameters:

subaccount - The subaccount to remove.

Returns:

true if this list contained the specified element, false otherwise.

removeSubaccounts

public boolean removeSubaccounts(@NonNull
 @NonNull Subaccount... subaccounts)

Removes the specified Subaccounts from this account's subaccounts list, if they are present.

Parameters:

subaccounts - The subaccounts to remove.

Returns:

true if this list was modified as a result of this operation.

removeSubaccount

@NonNull
public @NonNull Subaccount removeSubaccount(int index)
                                     throws IndexOutOfBoundsException

Removes the subaccount at the specified position in this account's subaccounts list.

Parameters:

index - The index of the subaccount to remove. Must be between 0 (inclusive) and the size of the list (exclusive).

Returns:

The subaccount previously at the specified position.

Throws:

IndexOutOfBoundsException - If the index is out of range.

removeSubaccounts

@NonNull
public @NonNull ArrayList<Subaccount> removeSubaccounts(int... indices)
                                                 throws IndexOutOfBoundsException

Removes the subaccounts at the specified positions in this account's subaccounts list.

Parameters:

indices - The indices of the subaccounts to remove. Must be between 0 (inclusive) and the size of the list (exclusive).

Returns:

The subaccounts previously at the specified positions.

Throws:

IndexOutOfBoundsException - If any of the indices are out of range.

clearSubaccounts

public void clearSubaccounts()

Removes all subaccounts from this account's subaccounts list.

addModule

public void addModule(@NonNull
 @NonNull Module module)

Adds a Module to the end of this grade table's modules list.

Parameters:

module - The module to add.

addModules

public void addModules(@NonNull
 @NonNull Module... modules)

Adds the specified Modules to the end of this grade table's modules list.

Parameters:

modules - The modules to add.

removeModule

public boolean removeModule(@NonNull
 @NonNull Module module)

Removes the first occurrence of the specified Module from this grade table's modules list, if it is present.

Parameters:

module - The module to remove.

Returns:

true if this list contained the specified element, false otherwise.

removeModules

public boolean removeModules(@NonNull
 @NonNull Module... modules)

Removes the specified Modules from this grade table's modules list, if they are present.

Parameters:

modules - The modules to remove.

Returns:

true if this list was modified as a result of this operation.

removeModule

@NonNull
public @NonNull Module removeModule(int index)
                             throws IndexOutOfBoundsException

Removes the module at the specified position in this grade table's modules list.

Parameters:

index - The index of the module to remove. Must be between 0 (inclusive) and the size of the list (exclusive).

Returns:

The module previously at the specified position.

Throws:

IndexOutOfBoundsException - If the index is out of range.

removeModules

@NonNull
public @NonNull ArrayList<Module> removeModules(int... indices)
                                         throws IndexOutOfBoundsException

Removes the modules at the specified positions in this grade table's modules list.

Parameters:

indices - The indices of the modules to remove. Must be between 0 (inclusive) and the size of the list (exclusive).

Returns:

The modules previously at the specified positions.

Throws:

IndexOutOfBoundsException - If any of the indices are out of range.

clearModules

public void clearModules()

Removes all modules from this grade table's modules list.

equals

public boolean equals(Object object)

Checks whether this GradesTable's fields are equal to their counterparts in the specified object (if it is a GradesTable at all).

Overrides:

equals in class Object

Parameters:

object - The object to compare this GradesTable to.

Returns:

true if the objects are deeply equal, false otherwise.

toJSON

@NonNull
public @NonNull String toJSON()
                       throws com.fasterxml.jackson.core.JsonProcessingException

Converts this GradesTable to a JSON string with all fields.

Returns:

The JSON representation of this object.

Throws:

com.fasterxml.jackson.core.JsonProcessingException - If the object could not be converted to JSON. See ObjectMapper.writeValueAsString(Object).

saveTo

public void saveTo(@NonNull
 @NonNull File file)
            throws IllegalArgumentException,
IOException

Writes this GradesTable to the specified file in JSON format.

Parameters:

file - The file to save this object to. Must exist, not be a directory and be writable.

Throws:

IllegalArgumentException - If the file does not exist, is a directory or is not writable.

IOException - If the file could not be written to. See Writer.write(String).

toString

@NonNull
public @NonNull String toString()

Overrides:

toString in class Object

Returns:

A string representation of this GradesTable with all fields as well as this object's hash code.